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

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

All Implemented Interfaces:

GPTool

public class MakeMosaicLayer
extends AbstractGPTool

Makes a temporary mosaic layer that will be available to select as a variable while working in the same ArcMap, ArcGlobe, ArcScene, or ArcCatalog session. The Make Mosaic Layer tool is contained in the Data Management Tools tool box.

Usage tips:

• To make your layer permanent, right-click the layer in the table of contents and click Save As Layer File, or use the .

Field Summary

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

vals

Constructor Summary

MakeMosaicLayer()
Creates the Make Mosaic Layer tool with defaults.

MakeMosaicLayer(Object inMosaicDataset, Object outMosaicLayer)
Creates the Make Mosaic Layer tool with the required parameters.

Method Summary

Object	getBandIndex() Returns the Bands parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
String	getLockRasterid() Returns the Lock Raster ID parameter of this tool .
String	getMosaicMethod() Returns the Mosaic Method parameter of this tool .
String	getMosaicOperator() Returns the Mosaic Operator parameter of this tool .
String	getOrderBaseValue() Returns the Order Base Value parameter of this tool .
String	getOrderField() Returns the Order Field parameter of this tool .
Object	getOutMosaicLayer() Returns the Output Mosaic Layer parameter of this tool .
String	getSortOrder() Returns the Sort Order parameter of this tool .
Object	getTemplate() Returns the Template Extent 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.
Object	getWhereClause() Returns the Expression parameter of this tool .
void	setBandIndex(Object bandIndex) Sets the Bands parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setLockRasterid(String lockRasterid) Sets the Lock Raster ID parameter of this tool .
void	setMosaicMethod(String mosaicMethod) Sets the Mosaic Method parameter of this tool .
void	setMosaicOperator(String mosaicOperator) Sets the Mosaic Operator parameter of this tool .
void	setOrderBaseValue(String orderBaseValue) Sets the Order Base Value parameter of this tool .
void	setOrderField(String orderField) Sets the Order Field parameter of this tool .
void	setOutMosaicLayer(Object outMosaicLayer) Sets the Output Mosaic Layer parameter of this tool .
void	setSortOrder(String sortOrder) Sets the Sort Order parameter of this tool .
void	setTemplate(Object template) Sets the Template Extent parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression 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

MakeMosaicLayer

public MakeMosaicLayer()

Creates the Make Mosaic Layer tool with defaults.

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

MakeMosaicLayer

public MakeMosaicLayer(Object inMosaicDataset,
                       Object outMosaicLayer)

Creates the Make Mosaic Layer 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 input mosaic dataset.

outMosaicLayer - the name of the temporary output mosaic layer.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is the path and name of the input mosaic dataset. 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 input mosaic dataset. This is a required parameter.

Parameters:

inMosaicDataset - the path and name of the input mosaic dataset.

getOutMosaicLayer

public Object getOutMosaicLayer()

Returns the Output Mosaic Layer parameter of this tool . This parameter is the name of the temporary output mosaic layer. This is a required parameter.

Returns:

the Output Mosaic Layer

setOutMosaicLayer

public void setOutMosaicLayer(Object outMosaicLayer)

Sets the Output Mosaic Layer parameter of this tool . This parameter is the name of the temporary output mosaic layer. This is a required parameter.

Parameters:

outMosaicLayer - the name of the temporary output mosaic layer.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is a query statement using the fields and values of the mosaic dataset. This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is a query statement using the fields and values of the mosaic dataset. This is an optional parameter.

Parameters:

whereClause - a query statement using the fields and values of the mosaic dataset.

getTemplate

public Object getTemplate()

Returns the Template Extent parameter of this tool . This parameter is using the min x, min y, max x, or max y, you can specify the extents of the output mosaic layer. This is an optional parameter.

Returns:

the Template Extent

setTemplate

public void setTemplate(Object template)

Sets the Template Extent parameter of this tool . This parameter is using the min x, min y, max x, or max y, you can specify the extents of the output mosaic layer. This is an optional parameter.

Parameters:

template - using the min x, min y, max x, or max y, you can specify the extents of the output mosaic layer.

getBandIndex

public Object getBandIndex()

Returns the Bands parameter of this tool . This parameter is choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output. This is an optional parameter.

Returns:

the Bands

setBandIndex

public void setBandIndex(Object bandIndex)

Sets the Bands parameter of this tool . This parameter is choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output. This is an optional parameter.

Parameters:

bandIndex - choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output.

getMosaicMethod

public String getMosaicMethod()

Returns the Mosaic Method parameter of this tool . This parameter is choose the mosaic method. The mosaic method defines how the layer is created from different rasters within the mosaic dataset. This is an optional parameter.

Returns:

the Mosaic Method

setMosaicMethod

public void setMosaicMethod(String mosaicMethod)

Sets the Mosaic Method parameter of this tool . This parameter is choose the mosaic method. The mosaic method defines how the layer is created from different rasters within the mosaic dataset. This is an optional parameter.

Parameters:

mosaicMethod - choose the mosaic method. The mosaic method defines how the layer is created from different rasters within the mosaic dataset.

getOrderField

public String getOrderField()

Returns the Order Field parameter of this tool . This parameter is choose the order field. When the mosaic method is BY_ATTRIBUTE, the default field to use when ordering rasters needs to be set. The list of fields is defined as those in the service table that are of type metadata. This is an optional parameter.

Returns:

the Order Field

setOrderField

public void setOrderField(String orderField)

Sets the Order Field parameter of this tool . This parameter is choose the order field. When the mosaic method is BY_ATTRIBUTE, the default field to use when ordering rasters needs to be set. The list of fields is defined as those in the service table that are of type metadata. This is an optional parameter.

Parameters:

orderField - choose the order field. When the mosaic method is BY_ATTRIBUTE, the default field to use when ordering rasters needs to be set. The list of fields is defined as those in the service table that are of type metadata.

getOrderBaseValue

public String getOrderBaseValue()

Returns the Order Base Value parameter of this tool . This parameter is type an order base value. The images are sorted based on the difference between this value and attribute value in the specified field. This is an optional parameter.

Returns:

the Order Base Value

setOrderBaseValue

public void setOrderBaseValue(String orderBaseValue)

Sets the Order Base Value parameter of this tool . This parameter is type an order base value. The images are sorted based on the difference between this value and attribute value in the specified field. This is an optional parameter.

Parameters:

orderBaseValue - type an order base value. The images are sorted based on the difference between this value and attribute value in the specified field.

getLockRasterid

public String getLockRasterid()

Returns the Lock Raster ID parameter of this tool . This parameter is choose the Raster ID or raster name to which the service should be locked, and that only the specified rasters are displayed. If left undefined, it will be similar to system default. Multiple IDs can be defined as a semicolon-delimited list. This is an optional parameter.

Returns:

the Lock Raster ID

setLockRasterid

public void setLockRasterid(String lockRasterid)

Sets the Lock Raster ID parameter of this tool . This parameter is choose the Raster ID or raster name to which the service should be locked, and that only the specified rasters are displayed. If left undefined, it will be similar to system default. Multiple IDs can be defined as a semicolon-delimited list. This is an optional parameter.

Parameters:

lockRasterid - choose the Raster ID or raster name to which the service should be locked, and that only the specified rasters are displayed. If left undefined, it will be similar to system default. Multiple IDs can be defined as a semicolon-delimited list.

getSortOrder

public String getSortOrder()

Returns the Sort Order parameter of this tool . This parameter is choose whether the sort order is ascending or descending. check this box to use an ascending order for your rasters; this is the default setting. If you wish to use a descending order for your rasters, then uncheck this box. This is an optional parameter.

Returns:

the Sort Order

setSortOrder

public void setSortOrder(String sortOrder)

Sets the Sort Order parameter of this tool . This parameter is choose whether the sort order is ascending or descending. check this box to use an ascending order for your rasters; this is the default setting. If you wish to use a descending order for your rasters, then uncheck this box. This is an optional parameter.

Parameters:

sortOrder - choose whether the sort order is ascending or descending. check this box to use an ascending order for your rasters; this is the default setting. If you wish to use a descending order for your rasters, then uncheck this box.

getMosaicOperator

public String getMosaicOperator()

Returns the Mosaic Operator parameter of this tool . This parameter is choose which mosaic operator to use. When two or more rasters all have the same sort priority, this parameter is used to further refine the sort order. This is an optional parameter.

Returns:

the Mosaic Operator

setMosaicOperator

public void setMosaicOperator(String mosaicOperator)

Sets the Mosaic Operator parameter of this tool . This parameter is choose which mosaic operator to use. When two or more rasters all have the same sort priority, this parameter is used to further refine the sort order. This is an optional parameter.

Parameters:

mosaicOperator - choose which mosaic operator to use. When two or more rasters all have the same sort priority, this parameter is used to further refine the sort order.

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