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

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

All Implemented Interfaces:

GPTool

public class MakeRasterCatalogLayer
extends AbstractGPTool

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

Usage tips:

• To make your layer permanent, right-click the layer in the ArcMap 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

MakeRasterCatalogLayer()
Creates the Make Raster Catalog Layer tool with defaults.

MakeRasterCatalogLayer(Object inRasterCatalog, Object layerName)
Creates the Make Raster Catalog Layer tool with the required parameters.

Method Summary

Object	getFieldInfo() Returns the Field Info parameter of this tool .
Object	getInRasterCatalog() Returns the Raster Catalog parameter of this tool .
Object	getLayerName() Returns the Layer Name or Table View 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 .
Object	getWorkspace() Returns the Workspace parameter of this tool .
void	setFieldInfo(Object fieldInfo) Sets the Field Info parameter of this tool .
void	setInRasterCatalog(Object inRasterCatalog) Sets the Raster Catalog parameter of this tool .
void	setLayerName(Object layerName) Sets the Layer Name or Table View parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression parameter of this tool .
void	setWorkspace(Object workspace) Sets the Workspace 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

MakeRasterCatalogLayer

public MakeRasterCatalogLayer()

Creates the Make Raster Catalog Layer tool with defaults.

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

MakeRasterCatalogLayer

public MakeRasterCatalogLayer(Object inRasterCatalog,
                              Object layerName)

Creates the Make Raster Catalog 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:

inRasterCatalog - the raster catalog containing one or more raster catalog items (raster datasets).

layerName - name of the temporary raster catalog layer.

Method Detail

getInRasterCatalog

public Object getInRasterCatalog()

Returns the Raster Catalog parameter of this tool . This parameter is the raster catalog containing one or more raster catalog items (raster datasets). This is a required parameter.

Returns:

the Raster Catalog

setInRasterCatalog

public void setInRasterCatalog(Object inRasterCatalog)

Sets the Raster Catalog parameter of this tool . This parameter is the raster catalog containing one or more raster catalog items (raster datasets). This is a required parameter.

Parameters:

inRasterCatalog - the raster catalog containing one or more raster catalog items (raster datasets).

getLayerName

public Object getLayerName()

Returns the Layer Name or Table View parameter of this tool . This parameter is name of the temporary raster catalog layer. This is a required parameter.

Returns:

the Layer Name or Table View

setLayerName

public void setLayerName(Object layerName)

Sets the Layer Name or Table View parameter of this tool . This parameter is name of the temporary raster catalog layer. This is a required parameter.

Parameters:

layerName - name of the temporary raster catalog layer.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is an SQL expression used to select a subset of raster catalog items. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD]. This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is an SQL expression used to select a subset of raster catalog items. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD]. This is an optional parameter.

Parameters:

whereClause - an SQL expression used to select a subset of raster catalog items. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD].

getWorkspace

public Object getWorkspace()

Returns the Workspace parameter of this tool . This parameter is the input workspace used to validate the field names. If the input is from a file or personal geodatabase and the output workspace is an ArcSDE geodatabase, the field names may be truncated, since some database fields can only have names with ten characters or less. The new names may be reviewed and altered using the Field Info parameter. This is an optional parameter.

Returns:

the Workspace

setWorkspace

public void setWorkspace(Object workspace)

Sets the Workspace parameter of this tool . This parameter is the input workspace used to validate the field names. If the input is from a file or personal geodatabase and the output workspace is an ArcSDE geodatabase, the field names may be truncated, since some database fields can only have names with ten characters or less. The new names may be reviewed and altered using the Field Info parameter. This is an optional parameter.

Parameters:

workspace - the input workspace used to validate the field names. If the input is from a file or personal geodatabase and the output workspace is an ArcSDE geodatabase, the field names may be truncated, since some database fields can only have names with ten characters or less. The new names may be reviewed and altered using the Field Info parameter.

getFieldInfo

public Object getFieldInfo()

Returns the Field Info parameter of this tool . This parameter is specifies which fields from the input table to rename and make visible in the output table view. This is an optional parameter.

Returns:

the Field Info

setFieldInfo

public void setFieldInfo(Object fieldInfo)

Sets the Field Info parameter of this tool . This parameter is specifies which fields from the input table to rename and make visible in the output table view. This is an optional parameter.

Parameters:

fieldInfo - specifies which fields from the input table to rename and make visible in the output table view.

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