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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• Once the raster catalog is created, raster datasets can be loaded into it.
• Raster catalogs can be created in any type of geodatabase: personal, file, or ArcSDE.
• Once a raster catalog is created, raster datasets can be loaded into it by right-clicking the raster catalog and selecting Load Data. Raster datasets can also be loaded into a raster catalog using the .
• Raster catalogs can be managed or unmanaged by the geodatabase. When the raster catalog is managed by the geodatabase means then the raster datasets inside the raster catalog will be physically stored within the geodatabase. When a row or raster is deleted from the catalog, it is deleted from the geodatabase. When the raster catalog is unmanaged, the raster catalog only contains links or pointers connecting a raster catalog row to a raster dataset stored outside the geodatabase. These raster datasets are stored outside the geodatabase. All raster datasets loaded into an unmanaged raster catalog must be a file on disk. Geodatabase raster datasets can only be loaded into raster catalogs that are managed. Raster Catalogs stored in an ArcSDE geodatabase are always managed.
• If the default value of zero is used for the spatial grid index, it is recommended that you load data in the raster catalog using the tool. If the tool is used to load raster datasets, the spatial grid size will be automatically calculated. If another tool is used to load raster datasets into a raster catalog, the tool needs to be used after the loading is completed.
• When creating a raster catalog in an ArcSDE geodatabase, the raster dataset name cannot have spaces. Use underscores to separate words in raster dataset names.

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 - the geodatabase to contain the raster catalog. This can be any type of geodatabase: personal, file, or ArcSDE.

outName - 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 the geodatabase to contain the raster catalog. This can be 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 the geodatabase to contain the raster catalog. This can be any type of geodatabase: personal, file, or ArcSDE. This is a required parameter.

Parameters:

outPath - the geodatabase to contain the raster catalog. This can be any type of geodatabase: personal, file, or ArcSDE.

getOutName

public String getOutName()

Returns the Raster Catalog Name parameter of this tool . This parameter is 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 the name of the raster catalog to be created. This is a required parameter.

Parameters:

outName - 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 the coordinate system for the raster column in the raster catalog. the spatial reference of the raster column is used during data loading as 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 the coordinate system for the raster column in the raster catalog. the spatial reference of the raster column is used during data loading as the default value is the coordinate system set in the environment settings. This is an optional parameter.

Parameters:

rasterSpatialReference - the coordinate system for the raster column in the raster catalog. the spatial reference of the raster column is used during data loading as 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 the coordinate system for the geometry column. the spatial reference for the geometry column defines the spatial reference of the footprints of the raster datasets. 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 the coordinate system for the geometry column. the spatial reference for the geometry column defines the spatial reference of the footprints of the raster datasets. the default value is the coordinate system set in the environment settings. This is an optional parameter.

Parameters:

spatialReference - the coordinate system for the geometry column. the spatial reference for the geometry column defines the spatial reference of the footprints of the raster datasets. 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 specifies the storage parameters (configuration) for a file geodatabase and an ArcSDE geodatabase. Personal geodatabases do not use configuration keywords. 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 specifies the storage parameters (configuration) for a file geodatabase and an ArcSDE geodatabase. Personal geodatabases do not use configuration keywords. arcSDE configuration keywords are set up by your database administrator. This is an optional parameter.

Parameters:

configKeyword - specifies the storage parameters (configuration) for a file geodatabase and an ArcSDE geodatabase. Personal geodatabases do not use configuration keywords. 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 the Output Spatial Grid 1, 2, and 3 parameters are used to compute a spatial index and only apply to file geodatabases and ArcSDE geodatabases. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. if you use the default spatial grid index (of zero), it is recommended that you load data using the Workspace To Raster Catalog tool. If the Workspace To Raster Catalog tool is used to load raster datasets, the spatial grid size will be automatically calculated. If another tool is used to load raster datasets into a raster catalog, the Calculate Default Spatial Grid Index (Data Management) tool needs to be used after the loading is completed. for more information about this parameter, refer to the Add Spatial Index tool documentation. 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 the Output Spatial Grid 1, 2, and 3 parameters are used to compute a spatial index and only apply to file geodatabases and ArcSDE geodatabases. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. if you use the default spatial grid index (of zero), it is recommended that you load data using the Workspace To Raster Catalog tool. If the Workspace To Raster Catalog tool is used to load raster datasets, the spatial grid size will be automatically calculated. If another tool is used to load raster datasets into a raster catalog, the Calculate Default Spatial Grid Index (Data Management) tool needs to be used after the loading is completed. for more information about this parameter, refer to the Add Spatial Index tool documentation. This is an optional parameter.

Parameters:

spatialGrid1 - the Output Spatial Grid 1, 2, and 3 parameters are used to compute a spatial index and only apply to file geodatabases and ArcSDE geodatabases. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. if you use the default spatial grid index (of zero), it is recommended that you load data using the Workspace To Raster Catalog tool. If the Workspace To Raster Catalog tool is used to load raster datasets, the spatial grid size will be automatically calculated. If another tool is used to load raster datasets into a raster catalog, the Calculate Default Spatial Grid Index (Data Management) tool needs to be used after the loading is completed. for more information about this parameter, refer to the Add Spatial Index tool documentation.

getSpatialGrid2

public double getSpatialGrid2()

Returns the Output Spatial Grid 2 parameter of this tool . This parameter is cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. 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 cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. This is an optional parameter.

Parameters:

spatialGrid2 - cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1.

getSpatialGrid3

public double getSpatialGrid3()

Returns the Output Spatial Grid 3 parameter of this tool . This parameter is cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set to at least three times larger than Spatial Grid 2. 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 cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set to at least three times larger than Spatial Grid 2. This is an optional parameter.

Parameters:

spatialGrid3 - cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set to at least three times larger than Spatial Grid 2.

getRasterManagementType

public String getRasterManagementType()

Returns the Raster Management Type parameter of this tool . This parameter is 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 raster datasets within raster catalogs can be managed in two ways: managed or unmanaged (by the geodatabase). This is an optional parameter.

Parameters:

rasterManagementType - raster datasets within raster catalogs can be managed in two ways: managed or unmanaged (by the geodatabase).

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.

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

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