com.esri.arcgis.geoprocessing.tools.samples
Class WorkspaceToNewRasterCatalog

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.samples.WorkspaceToNewRasterCatalog
All Implemented Interfaces:
GPTool

public class WorkspaceToNewRasterCatalog
extends AbstractGPTool

Creates a new raster catalog and loads all the raster datasets in the input workspace, or geodatabase, to the raster catalog. The spatial reference of both the raster column and the geometry column are taken from the first raster dataset in the input workspace. The x,y domain of the geometry column is calculated with the union extents of all the raster dataset inputs. There must be a spatial reference attached to the raster datasets for the tool to run. The Workspace To New Raster Catalog tool is contained in the Samples tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
WorkspaceToNewRasterCatalog()
          Creates the Workspace To New Raster Catalog tool with defaults.
WorkspaceToNewRasterCatalog(java.lang.Object inputWorkspace, java.lang.Object outputLocation, java.lang.String rasterCatalogName)
          Creates the Workspace To New Raster Catalog tool with the required parameters.
 
Method Summary
 java.lang.String getConfigurationKeyword()
          Returns the Configuration Keyword parameter of this tool .
 java.lang.Object getDerivedRasterCatalog()
          Returns the Derived Raster Catalog parameter of this tool (Read only).
 java.lang.Object getInputWorkspace()
          Returns the Input Workspace parameter of this tool .
 java.lang.String getManagementType()
          Returns the Management Type parameter of this tool .
 java.lang.Object getOutputLocation()
          Returns the Output Location parameter of this tool .
 java.lang.String getRasterCatalogName()
          Returns the Raster Catalog Name parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setConfigurationKeyword(java.lang.String configurationKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setInputWorkspace(java.lang.Object inputWorkspace)
          Sets the Input Workspace parameter of this tool .
 void setManagementType(java.lang.String managementType)
          Sets the Management Type parameter of this tool .
 void setOutputLocation(java.lang.Object outputLocation)
          Sets the Output Location parameter of this tool .
 void setRasterCatalogName(java.lang.String rasterCatalogName)
          Sets the Raster Catalog Name 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

WorkspaceToNewRasterCatalog

public WorkspaceToNewRasterCatalog()
Creates the Workspace To New Raster Catalog tool with defaults.

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


WorkspaceToNewRasterCatalog

public WorkspaceToNewRasterCatalog(java.lang.Object inputWorkspace,
                                   java.lang.Object outputLocation,
                                   java.lang.String rasterCatalogName)
Creates the Workspace To New Raster Catalog 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:
inputWorkspace - null
outputLocation - null
rasterCatalogName - null
Method Detail

getInputWorkspace

public java.lang.Object getInputWorkspace()
Returns the Input Workspace parameter of this tool . This is a required parameter.

Returns:
the Input Workspace

setInputWorkspace

public void setInputWorkspace(java.lang.Object inputWorkspace)
Sets the Input Workspace parameter of this tool . This is a required parameter.

Parameters:
inputWorkspace - null

getOutputLocation

public java.lang.Object getOutputLocation()
Returns the Output Location parameter of this tool . This is a required parameter.

Returns:
the Output Location

setOutputLocation

public void setOutputLocation(java.lang.Object outputLocation)
Sets the Output Location parameter of this tool . This is a required parameter.

Parameters:
outputLocation - null

getRasterCatalogName

public java.lang.String getRasterCatalogName()
Returns the Raster Catalog Name parameter of this tool . This is a required parameter.

Returns:
the Raster Catalog Name

setRasterCatalogName

public void setRasterCatalogName(java.lang.String rasterCatalogName)
Sets the Raster Catalog Name parameter of this tool . This is a required parameter.

Parameters:
rasterCatalogName - null

getConfigurationKeyword

public java.lang.String getConfigurationKeyword()
Returns the Configuration Keyword parameter of this tool . This is an optional parameter.

Returns:
the Configuration Keyword

setConfigurationKeyword

public void setConfigurationKeyword(java.lang.String configurationKeyword)
Sets the Configuration Keyword parameter of this tool . This is an optional parameter.

Parameters:
configurationKeyword - null

getManagementType

public java.lang.String getManagementType()
Returns the Management Type parameter of this tool . This is an optional parameter.

Returns:
the Management Type

setManagementType

public void setManagementType(java.lang.String managementType)
Sets the Management Type parameter of this tool . This is an optional parameter.

Parameters:
managementType - null

getDerivedRasterCatalog

public java.lang.Object getDerivedRasterCatalog()
Returns the Derived Raster Catalog parameter of this tool (Read only). This is an derived parameter.

Returns:
the Derived Raster Catalog

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias