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

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

public class CreateRasterCatalog
extends AbstractGPTool

Creates an empty raster catalog in a geodatabase. The Create Raster Catalog tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateRasterCatalog()
          Creates the Create Raster Catalog tool with defaults.
CreateRasterCatalog(Object outPath, String outName)
          Creates the Create Raster Catalog tool with the required parameters.
 
Method Summary
 String getConfigKeyword()
          Returns the Configuration Keyword parameter of this tool .
 String getOutName()
          Returns the Raster Catalog Name parameter of this tool .
 Object getOutPath()
          Returns the Output Location parameter of this tool .
 Object getOutRasterCatalog()
          Returns the Output Raster Catalog parameter of this tool (Read only).
 String getRasterManagementType()
          Returns the Raster Management Type parameter of this tool .
 Object getRasterSpatialReference()
          Returns the Coordinate System for Raster Column parameter of this tool .
 double getSpatialGrid1()
          Returns the Output Spatial Grid 1 parameter of this tool .
 double getSpatialGrid2()
          Returns the Output Spatial Grid 2 parameter of this tool .
 double getSpatialGrid3()
          Returns the Output Spatial Grid 3 parameter of this tool .
 Object getSpatialReference()
          Returns the Coordinate System for Geometry Column parameter of this tool .
 Object getTemplateRasterCatalog()
          Returns the Template Raster Catalog 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 setConfigKeyword(String configKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setOutName(String outName)
          Sets the Raster Catalog Name parameter of this tool .
 void setOutPath(Object outPath)
          Sets the Output Location parameter of this tool .
 void setRasterManagementType(String rasterManagementType)
          Sets the Raster Management Type parameter of this tool .
 void setRasterSpatialReference(Object rasterSpatialReference)
          Sets the Coordinate System for Raster Column parameter of this tool .
 void setSpatialGrid1(double spatialGrid1)
          Sets the Output Spatial Grid 1 parameter of this tool .
 void setSpatialGrid2(double spatialGrid2)
          Sets the Output Spatial Grid 2 parameter of this tool .
 void setSpatialGrid3(double spatialGrid3)
          Sets the Output Spatial Grid 3 parameter of this tool .
 void setSpatialReference(Object spatialReference)
          Sets the Coordinate System for Geometry Column parameter of this tool .
 void setTemplateRasterCatalog(Object templateRasterCatalog)
          Sets the Template Raster Catalog 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

CreateRasterCatalog

public CreateRasterCatalog()
Creates the Create Raster Catalog tool with defaults.

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


CreateRasterCatalog

public CreateRasterCatalog(Object outPath,
                           String outName)
Creates the Create 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:
outPath - Workspace, you can save your raster catalog to any type of geodatabase: personal , file , or ArcSDE.
outName - String, the name of the raster catalog to be created.
Method Detail

getOutPath

public Object getOutPath()
Returns the Output Location parameter of this tool . This parameter is Workspace, you can save your raster catalog to any type of geodatabase: personal , file , or ArcSDE. This is a required parameter.

Returns:
the Output Location

setOutPath

public void setOutPath(Object outPath)
Sets the Output Location parameter of this tool . This parameter is Workspace, you can save your raster catalog to any type of geodatabase: personal , file , or ArcSDE. This is a required parameter.

Parameters:
outPath - Workspace, you can save your raster catalog to any type of geodatabase: personal , file , or ArcSDE.

getOutName

public String getOutName()
Returns the Raster Catalog Name parameter of this tool . This parameter is String, the name of the raster catalog to be created. This is a required parameter.

Returns:
the Raster Catalog Name

setOutName

public void setOutName(String outName)
Sets the Raster Catalog Name parameter of this tool . This parameter is String, the name of the raster catalog to be created. This is a required parameter.

Parameters:
outName - String, the name of the raster catalog to be created.

getRasterSpatialReference

public Object getRasterSpatialReference()
Returns the Coordinate System for Raster Column parameter of this tool . This parameter is Coordinate system, the default value is the coordinate system set in the environment settings. This is an optional parameter.

Returns:
the Coordinate System for Raster Column

setRasterSpatialReference

public void setRasterSpatialReference(Object rasterSpatialReference)
Sets the Coordinate System for Raster Column parameter of this tool . This parameter is Coordinate system, the default value is the coordinate system set in the environment settings. This is an optional parameter.

Parameters:
rasterSpatialReference - Coordinate system, the default value is the coordinate system set in the environment settings.

getSpatialReference

public Object getSpatialReference()
Returns the Coordinate System for Geometry Column parameter of this tool . This parameter is Spatial reference, the default value is the coordinate system set in the environment settings. This is an optional parameter.

Returns:
the Coordinate System for Geometry Column

setSpatialReference

public void setSpatialReference(Object spatialReference)
Sets the Coordinate System for Geometry Column parameter of this tool . This parameter is Spatial reference, the default value is the coordinate system set in the environment settings. This is an optional parameter.

Parameters:
spatialReference - Spatial reference, the default value is the coordinate system set in the environment settings.

getConfigKeyword

public String getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . This parameter is String, arcSDE configuration keywords are set up by your database administrator. This is an optional parameter.

Returns:
the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Configuration Keyword parameter of this tool . This parameter is String, arcSDE configuration keywords are set up by your database administrator. This is an optional parameter.

Parameters:
configKeyword - String, arcSDE configuration keywords are set up by your database administrator.

getSpatialGrid1

public double getSpatialGrid1()
Returns the Output Spatial Grid 1 parameter of this tool . This parameter is Double, needs to be used after the loading is completed. This is an optional parameter.

Returns:
the Output Spatial Grid 1

setSpatialGrid1

public void setSpatialGrid1(double spatialGrid1)
Sets the Output Spatial Grid 1 parameter of this tool . This parameter is Double, needs to be used after the loading is completed. This is an optional parameter.

Parameters:
spatialGrid1 - Double, needs to be used after the loading is completed.

getSpatialGrid2

public double getSpatialGrid2()
Returns the Output Spatial Grid 2 parameter of this tool . This parameter is Double, . Personal geodatabases support only one spatial grid index. This is an optional parameter.

Returns:
the Output Spatial Grid 2

setSpatialGrid2

public void setSpatialGrid2(double spatialGrid2)
Sets the Output Spatial Grid 2 parameter of this tool . This parameter is Double, . Personal geodatabases support only one spatial grid index. This is an optional parameter.

Parameters:
spatialGrid2 - Double, . Personal geodatabases support only one spatial grid index.

getSpatialGrid3

public double getSpatialGrid3()
Returns the Output Spatial Grid 3 parameter of this tool . This parameter is Double, this value must be at least three times larger than the second grid index. Only the file geodatabase and ArcSDE geodatabase support more than one spatial grid index. Personal geodatabases support only one spatial grid index. This is an optional parameter.

Returns:
the Output Spatial Grid 3

setSpatialGrid3

public void setSpatialGrid3(double spatialGrid3)
Sets the Output Spatial Grid 3 parameter of this tool . This parameter is Double, this value must be at least three times larger than the second grid index. Only the file geodatabase and ArcSDE geodatabase support more than one spatial grid index. Personal geodatabases support only one spatial grid index. This is an optional parameter.

Parameters:
spatialGrid3 - Double, this value must be at least three times larger than the second grid index. Only the file geodatabase and ArcSDE geodatabase support more than one spatial grid index. Personal geodatabases support only one spatial grid index.

getRasterManagementType

public String getRasterManagementType()
Returns the Raster Management Type parameter of this tool . This parameter is String, in a personal geodatabase and file geodatabase, raster datasets within raster catalogs can be managed in two ways: managed or unmanaged (by the geodatabase). This is an optional parameter.

Returns:
the Raster Management Type

setRasterManagementType

public void setRasterManagementType(String rasterManagementType)
Sets the Raster Management Type parameter of this tool . This parameter is String, in a personal geodatabase and file geodatabase, raster datasets within raster catalogs can be managed in two ways: managed or unmanaged (by the geodatabase). This is an optional parameter.

Parameters:
rasterManagementType - String, in a personal geodatabase and file geodatabase, raster datasets within raster catalogs can be managed in two ways: managed or unmanaged (by the geodatabase).

getOutRasterCatalog

public Object getOutRasterCatalog()
Returns the Output Raster Catalog parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Raster Catalog

getTemplateRasterCatalog

public Object getTemplateRasterCatalog()
Returns the Template Raster Catalog parameter of this tool . This parameter is , if you want to base your new raster catalog on a template, you can specify a template raster catalog. The new raster catalog will then have the same fields as the template raster catalog. This is an optional parameter.

Returns:
the Template Raster Catalog

setTemplateRasterCatalog

public void setTemplateRasterCatalog(Object templateRasterCatalog)
Sets the Template Raster Catalog parameter of this tool . This parameter is , if you want to base your new raster catalog on a template, you can specify a template raster catalog. The new raster catalog will then have the same fields as the template raster catalog. This is an optional parameter.

Parameters:
templateRasterCatalog - , if you want to base your new raster catalog on a template, you can specify a template raster catalog. The new raster catalog will then have the same fields as the template raster catalog.

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