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

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

All Implemented Interfaces:

GPTool

public class ExportRasterCatalogPaths
extends AbstractGPTool

Creates a table listing the paths to the raster datasets contained in an unmanaged raster catalog or a mosaic dataset. The table can display all the file paths, or just the ones that are broken. The Export Raster Catalog Paths tool is contained in the Data Management Tools tool box.

Usage tips:

• The output of this tool is a table, either in a geodatabase or a .DBF file.

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(java.lang.Object inRasterCatalog, java.lang.String exportMode, java.lang.Object outTable)
Creates the Export Raster Catalog Paths tool with the required parameters.

Method Summary

java.lang.String	getExportMode() Returns the Export Mode parameter of this tool .
java.lang.Object	getInRasterCatalog() Returns the Input Data parameter of this tool .
java.lang.Object	getOutTable() Returns the Output Table parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setExportMode(java.lang.String exportMode) Sets the Export Mode parameter of this tool .
void	setInRasterCatalog(java.lang.Object inRasterCatalog) Sets the Input Data parameter of this tool .
void	setOutTable(java.lang.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(java.lang.Object inRasterCatalog,
                                java.lang.String exportMode,
                                java.lang.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 - the input unmanaged raster catalog or mosaic dataset.

exportMode - choose what paths to output to the table. You can choose to output all the file paths, or just the ones that are broken. choose the repair mode you would like to use.

outTable - the output table. This table can be created as a DBF file or within a geodatabase. 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 java.lang.Object getInRasterCatalog()

Returns the Input Data parameter of this tool . This parameter is the input unmanaged raster catalog or mosaic dataset. This is a required parameter.

Returns:

the Input Data

setInRasterCatalog

public void setInRasterCatalog(java.lang.Object inRasterCatalog)

Sets the Input Data parameter of this tool . This parameter is the input unmanaged raster catalog or mosaic dataset. This is a required parameter.

Parameters:

inRasterCatalog - the input unmanaged raster catalog or mosaic dataset.

getExportMode

public java.lang.String getExportMode()

Returns the Export Mode parameter of this tool . This parameter is choose what paths to output to the table. You can choose to output all the file 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(java.lang.String exportMode)

Sets the Export Mode parameter of this tool . This parameter is choose what paths to output to the table. You can choose to output all the file paths, or just the ones that are broken. choose the repair mode you would like to use. This is a required parameter.

Parameters:

exportMode - choose what paths to output to the table. You can choose to output all the file paths, or just the ones that are broken. choose the repair mode you would like to use.

getOutTable

public java.lang.Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the output table. This table can be created as a DBF file or within a geodatabase. 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(java.lang.Object outTable)

Sets the Output Table parameter of this tool . This parameter is the output table. This table can be created as a DBF file or within a geodatabase. 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 - the output table. This table can be created as a DBF file or within a geodatabase. 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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias