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

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

public class ExportRasterCatalogPaths
extends AbstractGPTool

Creates a table that lists the raster catalog paths contained in an unmanaged raster catalog. The Export Raster Catalog Paths 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
ExportRasterCatalogPaths()
          Creates the Export Raster Catalog Paths tool with defaults.
ExportRasterCatalogPaths(Object inRasterCatalog, String exportMode, Object outTable)
          Creates the Export Raster Catalog Paths tool with the required parameters.
 
Method Summary
 String getExportMode()
          Returns the Export Mode parameter of this tool .
 Object getInRasterCatalog()
          Returns the Input Raster Catalog parameter of this tool .
 Object getOutTable()
          Returns the Output Table 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 setExportMode(String exportMode)
          Sets the Export Mode parameter of this tool .
 void setInRasterCatalog(Object inRasterCatalog)
          Sets the Input Raster Catalog parameter of this tool .
 void setOutTable(Object outTable)
          Sets the Output Table 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

ExportRasterCatalogPaths

public ExportRasterCatalogPaths()
Creates the Export Raster Catalog Paths tool with defaults.

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


ExportRasterCatalogPaths

public ExportRasterCatalogPaths(Object inRasterCatalog,
                                String exportMode,
                                Object outTable)
Creates the Export Raster Catalog Paths 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, the input unmanaged raster catalog.
exportMode - String, choose what paths to output to the table. You can choose to output all the raster catalog paths, or just the ones that are broken. Choose the repair mode you would like to use.
outTable - String, the output table will have a field that lists the Source OID. This is the OID of the row in the original raster catalog table.
Method Detail

getInRasterCatalog

public Object getInRasterCatalog()
Returns the Input Raster Catalog parameter of this tool . This parameter is Raster Catalog, the input unmanaged raster catalog. 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, the input unmanaged raster catalog. This is a required parameter.

Parameters:
inRasterCatalog - Raster Catalog, the input unmanaged raster catalog.

getExportMode

public String getExportMode()
Returns the Export Mode parameter of this tool . This parameter is String, choose what paths to output to the table. You can choose to output all the raster catalog paths, or just the ones that are broken. Choose the repair mode you would like to use. This is a required parameter.

Returns:
the Export Mode

setExportMode

public void setExportMode(String exportMode)
Sets the Export Mode parameter of this tool . This parameter is String, choose what paths to output to the table. You can choose to output all the raster catalog paths, or just the ones that are broken. Choose the repair mode you would like to use. This is a required parameter.

Parameters:
exportMode - String, choose what paths to output to the table. You can choose to output all the raster catalog paths, or just the ones that are broken. Choose the repair mode you would like to use.

getOutTable

public Object getOutTable()
Returns the Output Table parameter of this tool . This parameter is String, the output table will have a field that lists the Source OID. This is the OID of the row in the original raster catalog table. This is a required parameter.

Returns:
the Output Table

setOutTable

public void setOutTable(Object outTable)
Sets the Output Table parameter of this tool . This parameter is String, the output table will have a field that lists the Source OID. This is the OID of the row in the original raster catalog table. This is a required parameter.

Parameters:
outTable - String, the output table will have a field that lists the Source OID. This is the OID of the row in the original raster catalog table.

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