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

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

All Implemented Interfaces:

GPTool

public class CopyRasterCatalogItems
extends AbstractGPTool

Makes a copy of a raster catalog, including all its contents, or a subset of its contents if there is a selection. The Copy Raster Catalog Items tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The input and output of this tool is a geodatabase raster catalog.
• You can copy your output raster catalog to any type of geodatabase: personal, file, or ArcSDE.
• When using ArcMap, you can use the Selection tool to choose which items to copy.
• If your raster catalog output is to a file geodatabase or an ArcSDE geodatabase, a configuration keyword can be set.
• The properties of the output raster catalog are the same as the input raster catalog, as well as the properties of the raster datasets in the raster catalog.
• The following environments affect this tool: current workspace; and scratch workspace;
• Learn more about geodatabase items - Spatial indexes and grid size;

Field Summary

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

vals

Constructor Summary

CopyRasterCatalogItems()
Creates the Copy Raster Catalog Items tool with defaults.

CopyRasterCatalogItems(Object inRasterCatalog, Object outRasterCatalog)
Creates the Copy Raster Catalog Items tool with the required parameters.

Method Summary

String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
Object	getInRasterCatalog() Returns the Input Raster Catalog parameter of this tool .
Object	getOutRasterCatalog() Returns the Output Raster Catalog 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 .
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	setInRasterCatalog(Object inRasterCatalog) Sets the Input Raster Catalog parameter of this tool .
void	setOutRasterCatalog(Object outRasterCatalog) Sets the Output Raster Catalog 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 .

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

CopyRasterCatalogItems

public CopyRasterCatalogItems()

Creates the Copy Raster Catalog Items tool with defaults.

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

CopyRasterCatalogItems

public CopyRasterCatalogItems(Object inRasterCatalog,
                              Object outRasterCatalog)

Creates the Copy Raster Catalog Items 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 - Raster catalog layer, the name and location of the raster catalog to be copied.

outRasterCatalog - Raster catalog, you can copy your output raster catalog to any type of geodatabase: personal , file , or ArcSDE.

Method Detail

getInRasterCatalog

public Object getInRasterCatalog()

Returns the Input Raster Catalog parameter of this tool . This parameter is Raster catalog layer, the name and location of the raster catalog to be copied. This is a required parameter.

Returns:

the Input Raster Catalog

setInRasterCatalog

public void setInRasterCatalog(Object inRasterCatalog)

Sets the Input Raster Catalog parameter of this tool . This parameter is Raster catalog layer, the name and location of the raster catalog to be copied. This is a required parameter.

Parameters:

inRasterCatalog - Raster catalog layer, the name and location of the raster catalog to be copied.

getOutRasterCatalog

public Object getOutRasterCatalog()

Returns the Output Raster Catalog parameter of this tool . This parameter is Raster catalog, you can copy your output raster catalog to any type of geodatabase: personal , file , or ArcSDE. This is a required parameter.

Returns:

the Output Raster Catalog

setOutRasterCatalog

public void setOutRasterCatalog(Object outRasterCatalog)

Sets the Output Raster Catalog parameter of this tool . This parameter is Raster catalog, you can copy your output raster catalog to any type of geodatabase: personal , file , or ArcSDE. This is a required parameter.

Parameters:

outRasterCatalog - Raster catalog, you can copy your output raster catalog to any type of geodatabase: personal , file , or ArcSDE.

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, the size of the output feature class's spatial grid index. All geodatabases support spatial grid indexes. 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, the size of the output feature class's spatial grid index. All geodatabases support spatial grid indexes. This is an optional parameter.

Parameters:

spatialGrid1 - Double, the size of the output feature class's spatial grid index. All geodatabases support spatial grid indexes.

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.

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