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

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

All Implemented Interfaces:

GPTool

public class WorkspaceToRasterCatalog
extends AbstractGPTool

Loads all the raster datasets stored in the same workspace into an existing raster catalog. The Workspace To Raster Catalog tool is contained in the Data Management Tools tool box.

Usage tips:

• All raster datasets within the specified workspace will be loaded into the raster catalog.
• The raster catalog must already exist for this tool to run.
• By default, the spatial reference and geotransformation of the raster datasets are persisted in the raster catalog. If you want to project the raster datasets to the spatial reference of the raster column in the raster catalog during loading, use the Project On-the-fly parameter.
• When loading raster datasets into a raster catalog with this tool, the spatial grid index is automatically calculated upon completion of the tool.
• If you are going to be loading data in a paralell process, you need to complete at least one load first, so that the spatial grid index is set properly. Then you can paralell load from as many servers as you want.

Field Summary

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

vals

Constructor Summary

WorkspaceToRasterCatalog()
Creates the Workspace To Raster Catalog tool with defaults.

WorkspaceToRasterCatalog(Object inWorkspace, Object inRasterCatalog)
Creates the Workspace To Raster Catalog tool with the required parameters.

Method Summary

String	getIncludeSubdirectories() Returns the Include Sub-directories parameter of this tool .
Object	getInRasterCatalog() Returns the Target Raster Catalog parameter of this tool .
Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
Object	getOutRasterCatalog() Returns the Output Raster Catalog parameter of this tool (Read only).
String	getProject() Returns the Project on-the-fly 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	setIncludeSubdirectories(String includeSubdirectories) Sets the Include Sub-directories parameter of this tool .
void	setInRasterCatalog(Object inRasterCatalog) Sets the Target Raster Catalog parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setProject(String project) Sets the Project on-the-fly 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

WorkspaceToRasterCatalog

public WorkspaceToRasterCatalog()

Creates the Workspace To Raster Catalog tool with defaults.

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

WorkspaceToRasterCatalog

public WorkspaceToRasterCatalog(Object inWorkspace,
                                Object inRasterCatalog)

Creates the Workspace To 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:

inWorkspace - the workspace that contains all the raster datasets to be loaded into the raster catalog.

inRasterCatalog - an existing raster catalog that will have all the raster datasets from the workspace loaded into it.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the workspace that contains all the raster datasets to be loaded into the raster catalog. This is a required parameter.

Returns:

the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input Workspace parameter of this tool . This parameter is the workspace that contains all the raster datasets to be loaded into the raster catalog. This is a required parameter.

Parameters:

inWorkspace - the workspace that contains all the raster datasets to be loaded into the raster catalog.

getInRasterCatalog

public Object getInRasterCatalog()

Returns the Target Raster Catalog parameter of this tool . This parameter is an existing raster catalog that will have all the raster datasets from the workspace loaded into it. This is a required parameter.

Returns:

the Target Raster Catalog

setInRasterCatalog

public void setInRasterCatalog(Object inRasterCatalog)

Sets the Target Raster Catalog parameter of this tool . This parameter is an existing raster catalog that will have all the raster datasets from the workspace loaded into it. This is a required parameter.

Parameters:

inRasterCatalog - an existing raster catalog that will have all the raster datasets from the workspace loaded into it.

getIncludeSubdirectories

public String getIncludeSubdirectories()

Returns the Include Sub-directories parameter of this tool . This parameter is specify whether to include subdirectories. This is an optional parameter.

Returns:

the Include Sub-directories

setIncludeSubdirectories

public void setIncludeSubdirectories(String includeSubdirectories)

Sets the Include Sub-directories parameter of this tool . This parameter is specify whether to include subdirectories. This is an optional parameter.

Parameters:

includeSubdirectories - specify whether to include subdirectories.

getProject

public String getProject()

Returns the Project on-the-fly parameter of this tool . This parameter is specify whether to project the raster datasets projected on the fly. This is an optional parameter.

Returns:

the Project on-the-fly

setProject

public void setProject(String project)

Sets the Project on-the-fly parameter of this tool . This parameter is specify whether to project the raster datasets projected on the fly. This is an optional parameter.

Parameters:

project - specify whether to project the raster datasets projected on the fly.

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