com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class AddRastersToMosaicDataset

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.AddRastersToMosaicDataset

All Implemented Interfaces:

GPTool

public class AddRastersToMosaicDataset
extends AbstractGPTool

Adds raster datasets to a mosaic dataset from many sources, including a file, folder, raster catalog, table, or Web service. The Add Rasters To Mosaic Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• Raster data that is added is unmanaged; therefore, if the raster data is deleted or moved the mosaic dataset will be affected.
• You can only add rasters to a mosaic dataset contained within a geodatabase. Those created outside a geodatabase can only contain the contents of a raster catalog or previously created mosaic dataset.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

AddRastersToMosaicDataset()
Creates the Add Rasters To Mosaic Dataset tool with defaults.

AddRastersToMosaicDataset(Object inMosaicDataset, Object rasterType, Object inputPath)
Creates the Add Rasters To Mosaic Dataset tool with the required parameters.

Method Summary

String	getBuildPyramids() Returns the Build Raster Pyramids parameter of this tool .
String	getBuildThumbnails() Returns the Build Thumbnails parameter of this tool .
String	getCalculateStatistics() Returns the Calculate Statistics parameter of this tool .
String	getDuplicateItemsAction() Returns the Add New Datasets Only parameter of this tool .
String	getFilter() Returns the File Filter parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
Object	getInputPath() Returns the Input parameter of this tool .
double	getMaximumCellSize() Returns the Maximum Cell Size parameter of this tool .
int	getMaximumPyramidLevels() Returns the Maximum Levels parameter of this tool .
int	getMinimumDimension() Returns the Minimum Rows or Columns parameter of this tool .
String	getOperationDescription() Returns the Operation Description parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
Object	getRasterType() Returns the Raster Type parameter of this tool .
Object	getSpatialReference() Returns the Coordinate System for Input Data parameter of this tool .
String	getSubFolder() Returns the Include Sub Folders parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
String	getUpdateBoundary() Returns the Update Boundary parameter of this tool .
String	getUpdateCellsizeRanges() Returns the Update Cell Size Ranges parameter of this tool .
String	getUpdateOverviews() Returns the Update Overviews parameter of this tool .
void	setBuildPyramids(String buildPyramids) Sets the Build Raster Pyramids parameter of this tool .
void	setBuildThumbnails(String buildThumbnails) Sets the Build Thumbnails parameter of this tool .
void	setCalculateStatistics(String calculateStatistics) Sets the Calculate Statistics parameter of this tool .
void	setDuplicateItemsAction(String duplicateItemsAction) Sets the Add New Datasets Only parameter of this tool .
void	setFilter(String filter) Sets the File Filter parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setInputPath(Object inputPath) Sets the Input parameter of this tool .
void	setMaximumCellSize(double maximumCellSize) Sets the Maximum Cell Size parameter of this tool .
void	setMaximumPyramidLevels(int maximumPyramidLevels) Sets the Maximum Levels parameter of this tool .
void	setMinimumDimension(int minimumDimension) Sets the Minimum Rows or Columns parameter of this tool .
void	setOperationDescription(String operationDescription) Sets the Operation Description parameter of this tool .
void	setRasterType(Object rasterType) Sets the Raster Type parameter of this tool .
void	setSpatialReference(Object spatialReference) Sets the Coordinate System for Input Data parameter of this tool .
void	setSubFolder(String subFolder) Sets the Include Sub Folders parameter of this tool .
void	setUpdateBoundary(String updateBoundary) Sets the Update Boundary parameter of this tool .
void	setUpdateCellsizeRanges(String updateCellsizeRanges) Sets the Update Cell Size Ranges parameter of this tool .
void	setUpdateOverviews(String updateOverviews) Sets the Update Overviews parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AddRastersToMosaicDataset

public AddRastersToMosaicDataset()

Creates the Add Rasters To Mosaic Dataset tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

AddRastersToMosaicDataset

public AddRastersToMosaicDataset(Object inMosaicDataset,
                                 Object rasterType,
                                 Object inputPath)

Creates the Add Rasters To Mosaic Dataset tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inMosaicDataset - the path and name of the mosaic dataset to which the raster data will be added.

rasterType - the raster type is specific for imagery products. It identifies metadata, such as georeferencing, acquisition date, and sensor type, along with a raster format.

inputPath - path and name of the file, folder, raster dataset, raster catalog, mosaic dataset, table, or service.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is the path and name of the mosaic dataset to which the raster data will be added. This is a required parameter.

Returns:

the Mosaic Dataset

setInMosaicDataset

public void setInMosaicDataset(Object inMosaicDataset)

Sets the Mosaic Dataset parameter of this tool . This parameter is the path and name of the mosaic dataset to which the raster data will be added. This is a required parameter.

Parameters:

inMosaicDataset - the path and name of the mosaic dataset to which the raster data will be added.

getRasterType

public Object getRasterType()

Returns the Raster Type parameter of this tool . This parameter is the raster type is specific for imagery products. It identifies metadata, such as georeferencing, acquisition date, and sensor type, along with a raster format. This is a required parameter.

Returns:

the Raster Type

setRasterType

public void setRasterType(Object rasterType)

Sets the Raster Type parameter of this tool . This parameter is the raster type is specific for imagery products. It identifies metadata, such as georeferencing, acquisition date, and sensor type, along with a raster format. This is a required parameter.

Parameters:

rasterType - the raster type is specific for imagery products. It identifies metadata, such as georeferencing, acquisition date, and sensor type, along with a raster format.

getInputPath

public Object getInputPath()

Returns the Input parameter of this tool . This parameter is path and name of the file, folder, raster dataset, raster catalog, mosaic dataset, table, or service. This is a required parameter.

Returns:

the Input

setInputPath

public void setInputPath(Object inputPath)

Sets the Input parameter of this tool . This parameter is path and name of the file, folder, raster dataset, raster catalog, mosaic dataset, table, or service. This is a required parameter.

Parameters:

inputPath - path and name of the file, folder, raster dataset, raster catalog, mosaic dataset, table, or service.

getUpdateCellsizeRanges

public String getUpdateCellsizeRanges()

Returns the Update Cell Size Ranges parameter of this tool . This parameter is calculates the cell size ranges of each raster in the mosaic dataset. These values are written to the attribute table within the minPS and maxPS columns. This is an optional parameter.

Returns:

the Update Cell Size Ranges

setUpdateCellsizeRanges

public void setUpdateCellsizeRanges(String updateCellsizeRanges)

Sets the Update Cell Size Ranges parameter of this tool . This parameter is calculates the cell size ranges of each raster in the mosaic dataset. These values are written to the attribute table within the minPS and maxPS columns. This is an optional parameter.

Parameters:

updateCellsizeRanges - calculates the cell size ranges of each raster in the mosaic dataset. These values are written to the attribute table within the minPS and maxPS columns.

getUpdateBoundary

public String getUpdateBoundary()

Returns the Update Boundary parameter of this tool . This parameter is generates or updates the boundary polygon of a mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels. This is an optional parameter.

Returns:

the Update Boundary

setUpdateBoundary

public void setUpdateBoundary(String updateBoundary)

Sets the Update Boundary parameter of this tool . This parameter is generates or updates the boundary polygon of a mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels. This is an optional parameter.

Parameters:

updateBoundary - generates or updates the boundary polygon of a mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels.

getUpdateOverviews

public String getUpdateOverviews()

Returns the Update Overviews parameter of this tool . This parameter is defines and generates overviews for a mosaic dataset. This is an optional parameter.

Returns:

the Update Overviews

setUpdateOverviews

public void setUpdateOverviews(String updateOverviews)

Sets the Update Overviews parameter of this tool . This parameter is defines and generates overviews for a mosaic dataset. This is an optional parameter.

Parameters:

updateOverviews - defines and generates overviews for a mosaic dataset.

getMaximumPyramidLevels

public int getMaximumPyramidLevels()

Returns the Maximum Levels parameter of this tool . This parameter is defines the maximum number of pyramid levels that will be used in the mosaic dataset. For example, a value of 2 will use only the first two pyramid levels from the source raster. Leaving this blank or typing a value of -1 will build pyramids for all levels. this value can affect the display and the number of overviews that will be generated. This is an optional parameter.

Returns:

the Maximum Levels

setMaximumPyramidLevels

public void setMaximumPyramidLevels(int maximumPyramidLevels)

Sets the Maximum Levels parameter of this tool . This parameter is defines the maximum number of pyramid levels that will be used in the mosaic dataset. For example, a value of 2 will use only the first two pyramid levels from the source raster. Leaving this blank or typing a value of -1 will build pyramids for all levels. this value can affect the display and the number of overviews that will be generated. This is an optional parameter.

Parameters:

maximumPyramidLevels - defines the maximum number of pyramid levels that will be used in the mosaic dataset. For example, a value of 2 will use only the first two pyramid levels from the source raster. Leaving this blank or typing a value of -1 will build pyramids for all levels. this value can affect the display and the number of overviews that will be generated.

getMaximumCellSize

public double getMaximumCellSize()

Returns the Maximum Cell Size parameter of this tool . This parameter is defines the maximum pyramid cell size that will be used in the mosaic dataset. This is an optional parameter.

Returns:

the Maximum Cell Size

setMaximumCellSize

public void setMaximumCellSize(double maximumCellSize)

Sets the Maximum Cell Size parameter of this tool . This parameter is defines the maximum pyramid cell size that will be used in the mosaic dataset. This is an optional parameter.

Parameters:

maximumCellSize - defines the maximum pyramid cell size that will be used in the mosaic dataset.

getMinimumDimension

public int getMinimumDimension()

Returns the Minimum Rows or Columns parameter of this tool . This parameter is defines the minimum dimensions of a raster pyramid that will be used in the mosaic dataset. This is an optional parameter.

Returns:

the Minimum Rows or Columns

setMinimumDimension

public void setMinimumDimension(int minimumDimension)

Sets the Minimum Rows or Columns parameter of this tool . This parameter is defines the minimum dimensions of a raster pyramid that will be used in the mosaic dataset. This is an optional parameter.

Parameters:

minimumDimension - defines the minimum dimensions of a raster pyramid that will be used in the mosaic dataset.

getSpatialReference

public Object getSpatialReference()

Returns the Coordinate System for Input Data parameter of this tool . This parameter is spatial reference system of the input data. this should be specified if the data does not have a coordinate system; otherwise, the coordinate system of the mosaic dataset will be used. This can also be used to override the coordinate system of the input data. This is an optional parameter.

Returns:

the Coordinate System for Input Data

setSpatialReference

public void setSpatialReference(Object spatialReference)

Sets the Coordinate System for Input Data parameter of this tool . This parameter is spatial reference system of the input data. this should be specified if the data does not have a coordinate system; otherwise, the coordinate system of the mosaic dataset will be used. This can also be used to override the coordinate system of the input data. This is an optional parameter.

Parameters:

spatialReference - spatial reference system of the input data. this should be specified if the data does not have a coordinate system; otherwise, the coordinate system of the mosaic dataset will be used. This can also be used to override the coordinate system of the input data.

getFilter

public String getFilter()

Returns the File Filter parameter of this tool . This parameter is a file name filter for the data to be added to the mosaic dataset. The wildcards for the filter can be a simple asterisk before a file extension, or it can be in the form or PERL syntax. This is an optional parameter.

Returns:

the File Filter

setFilter

public void setFilter(String filter)

Sets the File Filter parameter of this tool . This parameter is a file name filter for the data to be added to the mosaic dataset. The wildcards for the filter can be a simple asterisk before a file extension, or it can be in the form or PERL syntax. This is an optional parameter.

Parameters:

filter - a file name filter for the data to be added to the mosaic dataset. The wildcards for the filter can be a simple asterisk before a file extension, or it can be in the form or PERL syntax.

• *.TIF
• null
• null

getSubFolder

public String getSubFolder()

Returns the Include Sub Folders parameter of this tool . This parameter is recursively explores subfolders. This is an optional parameter.

Returns:

the Include Sub Folders

setSubFolder

public void setSubFolder(String subFolder)

Sets the Include Sub Folders parameter of this tool . This parameter is recursively explores subfolders. This is an optional parameter.

Parameters:

subFolder - recursively explores subfolders.

getDuplicateItemsAction

public String getDuplicateItemsAction()

Returns the Add New Datasets Only parameter of this tool . This is an optional parameter.

Returns:

the Add New Datasets Only

setDuplicateItemsAction

public void setDuplicateItemsAction(String duplicateItemsAction)

Sets the Add New Datasets Only parameter of this tool . This is an optional parameter.

Parameters:

duplicateItemsAction - null

getBuildPyramids

public String getBuildPyramids()

Returns the Build Raster Pyramids parameter of this tool . This parameter is builds pyramids for each source raster. This is an optional parameter.

Returns:

the Build Raster Pyramids

setBuildPyramids

public void setBuildPyramids(String buildPyramids)

Sets the Build Raster Pyramids parameter of this tool . This parameter is builds pyramids for each source raster. This is an optional parameter.

Parameters:

buildPyramids - builds pyramids for each source raster.

getCalculateStatistics

public String getCalculateStatistics()

Returns the Calculate Statistics parameter of this tool . This parameter is calculates statistics for each source raster. This is an optional parameter.

Returns:

the Calculate Statistics

setCalculateStatistics

public void setCalculateStatistics(String calculateStatistics)

Sets the Calculate Statistics parameter of this tool . This parameter is calculates statistics for each source raster. This is an optional parameter.

Parameters:

calculateStatistics - calculates statistics for each source raster.

getBuildThumbnails

public String getBuildThumbnails()

Returns the Build Thumbnails parameter of this tool . This parameter is builds thumbnails for each source raster. This is an optional parameter.

Returns:

the Build Thumbnails

setBuildThumbnails

public void setBuildThumbnails(String buildThumbnails)

Sets the Build Thumbnails parameter of this tool . This parameter is builds thumbnails for each source raster. This is an optional parameter.

Parameters:

buildThumbnails - builds thumbnails for each source raster.

getOperationDescription

public String getOperationDescription()

Returns the Operation Description parameter of this tool . This is an optional parameter.

Returns:

the Operation Description

setOperationDescription

public void setOperationDescription(String operationDescription)

Sets the Operation Description parameter of this tool . This is an optional parameter.

Parameters:

operationDescription - null

getOutMosaicDataset

public Object getOutMosaicDataset()

Returns the Mosaic Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Mosaic Dataset

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias