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

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

All Implemented Interfaces:

GPTool

public class CreateMosaicDataset
extends AbstractGPTool

Makes an empty mosaic dataset in a geodatabase. The Create Mosaic Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• The destination geodatabase can be file, personal, or ArcSDE.
• Once the mosaic dataset is created, you can use the to populate it with rasters.
• The name of the mosaic dataset must keep within the limits of the geodatabase or underlying database. For example, the name cannot start with a number.

Field Summary

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

vals

Constructor Summary

CreateMosaicDataset()
Creates the Create Mosaic Dataset tool with defaults.

CreateMosaicDataset(Object inWorkspace, String inMosaicdatasetName, Object coordinateSystem)
Creates the Create Mosaic Dataset tool with the required parameters.

Method Summary

Object	getCoordinateSystem() Returns the Coordinate System parameter of this tool .
String	getInMosaicdatasetName() Returns the Mosaic Dataset Name parameter of this tool .
Object	getInWorkspace() Returns the Output Location parameter of this tool .
int	getNumBands() Returns the Number of Bands parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset Name parameter of this tool (Read only).
String	getPixelType() Returns the Pixel Type 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.
void	setCoordinateSystem(Object coordinateSystem) Sets the Coordinate System parameter of this tool .
void	setInMosaicdatasetName(String inMosaicdatasetName) Sets the Mosaic Dataset Name parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Output Location parameter of this tool .
void	setNumBands(int numBands) Sets the Number of Bands parameter of this tool .
void	setPixelType(String pixelType) Sets the Pixel Type 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

CreateMosaicDataset

public CreateMosaicDataset()

Creates the Create Mosaic Dataset tool with defaults.

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

CreateMosaicDataset

public CreateMosaicDataset(Object inWorkspace,
                           String inMosaicdatasetName,
                           Object coordinateSystem)

Creates the Create 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:

inWorkspace - the path and name of a geodatabase.

inMosaicdatasetName - the name of the mosaic dataset.

coordinateSystem - the coordinate system for the mosaic dataset, which will be used for all the associated files or features created.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Output Location parameter of this tool . This parameter is the path and name of a geodatabase. This is a required parameter.

Returns:

the Output Location

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Output Location parameter of this tool . This parameter is the path and name of a geodatabase. This is a required parameter.

Parameters:

inWorkspace - the path and name of a geodatabase.

getInMosaicdatasetName

public String getInMosaicdatasetName()

Returns the Mosaic Dataset Name parameter of this tool . This parameter is the name of the mosaic dataset. This is a required parameter.

Returns:

the Mosaic Dataset Name

setInMosaicdatasetName

public void setInMosaicdatasetName(String inMosaicdatasetName)

Sets the Mosaic Dataset Name parameter of this tool . This parameter is the name of the mosaic dataset. This is a required parameter.

Parameters:

inMosaicdatasetName - the name of the mosaic dataset.

getCoordinateSystem

public Object getCoordinateSystem()

Returns the Coordinate System parameter of this tool . This parameter is the coordinate system for the mosaic dataset, which will be used for all the associated files or features created. This is a required parameter.

Returns:

the Coordinate System

setCoordinateSystem

public void setCoordinateSystem(Object coordinateSystem)

Sets the Coordinate System parameter of this tool . This parameter is the coordinate system for the mosaic dataset, which will be used for all the associated files or features created. This is a required parameter.

Parameters:

coordinateSystem - the coordinate system for the mosaic dataset, which will be used for all the associated files or features created.

getNumBands

public int getNumBands()

Returns the Number of Bands parameter of this tool . This parameter is the number of raster dataset bands supported by the mosaic dataset. This is an optional parameter.

Returns:

the Number of Bands

setNumBands

public void setNumBands(int numBands)

Sets the Number of Bands parameter of this tool . This parameter is the number of raster dataset bands supported by the mosaic dataset. This is an optional parameter.

Parameters:

numBands - the number of raster dataset bands supported by the mosaic dataset.

getPixelType

public String getPixelType()

Returns the Pixel Type parameter of this tool . This parameter is the bit depth of a cell, used to determine the range of values that the mosaic dataset output. For example, an 8-bit mosaic dataset can have 256 unique pixel values, which range from 0 to 255. if it is not defined it will be taken from the first raster dataset. This is an optional parameter.

Returns:

the Pixel Type

setPixelType

public void setPixelType(String pixelType)

Sets the Pixel Type parameter of this tool . This parameter is the bit depth of a cell, used to determine the range of values that the mosaic dataset output. For example, an 8-bit mosaic dataset can have 256 unique pixel values, which range from 0 to 255. if it is not defined it will be taken from the first raster dataset. This is an optional parameter.

Parameters:

pixelType - the bit depth of a cell, used to determine the range of values that the mosaic dataset output. For example, an 8-bit mosaic dataset can have 256 unique pixel values, which range from 0 to 255. if it is not defined it will be taken from the first raster dataset.

getOutMosaicDataset

public Object getOutMosaicDataset()

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

Returns:

the Mosaic Dataset Name

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