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

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

All Implemented Interfaces:

GPTool

public class RepairRasterCatalogPaths
extends AbstractGPTool

Repairs broken raster catalog paths or deletes broken links, within an unmanaged raster catalog. The Repair Raster Catalog Paths tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• Use this tool to fix any broken or changed links within an unmanaged raster catalog. It can also be used to delete any broken links that are no longer needed.
• This tool can only be used for unmanaged raster catalogs.
• You need to know the file path of the original raster catalog item location in order to change it. The Export Raster Catalog Paths geoprocessing tool can help you retrieve the original path names.
• You can type an asterisk (*) as the original path if you wish to change all your paths.

Field Summary

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

vals

Constructor Summary

RepairRasterCatalogPaths()
Creates the Repair Raster Catalog Paths tool with defaults.

RepairRasterCatalogPaths(Object inRasterCatalog, String repairMode)
Creates the Repair Raster Catalog Paths tool with the required parameters.

Method Summary

Object	getInRasterCatalog() Returns the Input Raster Catalog parameter of this tool .
String	getNewPath() Returns the New Path parameter of this tool .
String	getOriginalPath() Returns the Original Path parameter of this tool .
Object	getOutRasterCatalog() Returns the Output Raster Catalog parameter of this tool (Read only).
String	getRepairMode() Returns the Repair Mode 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	setInRasterCatalog(Object inRasterCatalog) Sets the Input Raster Catalog parameter of this tool .
void	setNewPath(String newPath) Sets the New Path parameter of this tool .
void	setOriginalPath(String originalPath) Sets the Original Path parameter of this tool .
void	setRepairMode(String repairMode) Sets the Repair Mode 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

RepairRasterCatalogPaths

public RepairRasterCatalogPaths()

Creates the Repair Raster Catalog Paths tool with defaults.

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

RepairRasterCatalogPaths

public RepairRasterCatalogPaths(Object inRasterCatalog,
                                String repairMode)

Creates the Repair 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 unmanaged raster catalog to be repaired.

repairMode - String, choose the repair mode you would like to use.

Method Detail

getInRasterCatalog

public Object getInRasterCatalog()

Returns the Input Raster Catalog parameter of this tool . This parameter is Raster catalog, the unmanaged raster catalog to be repaired. 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 unmanaged raster catalog to be repaired. This is a required parameter.

Parameters:

inRasterCatalog - Raster catalog, the unmanaged raster catalog to be repaired.

getRepairMode

public String getRepairMode()

Returns the Repair Mode parameter of this tool . This parameter is String, choose the repair mode you would like to use. This is a required parameter.

Returns:

the Repair Mode

setRepairMode

public void setRepairMode(String repairMode)

Sets the Repair Mode parameter of this tool . This parameter is String, choose the repair mode you would like to use. This is a required parameter.

Parameters:

repairMode - String, choose the repair mode you would like to use.

getOriginalPath

public String getOriginalPath()

Returns the Original Path parameter of this tool . This parameter is String, if you want to change all your paths to the new path, you are able to use the asterisk (*) as the original path. This is an optional parameter.

Returns:

the Original Path

setOriginalPath

public void setOriginalPath(String originalPath)

Sets the Original Path parameter of this tool . This parameter is String, if you want to change all your paths to the new path, you are able to use the asterisk (*) as the original path. This is an optional parameter.

Parameters:

originalPath - String, if you want to change all your paths to the new path, you are able to use the asterisk (*) as the original path.

getNewPath

public String getNewPath()

Returns the New Path parameter of this tool . This parameter is String, type the new path to use. This is a required parameter if the FIX option was chosen. This is an optional parameter.

Returns:

the New Path

setNewPath

public void setNewPath(String newPath)

Sets the New Path parameter of this tool . This parameter is String, type the new path to use. This is a required parameter if the FIX option was chosen. This is an optional parameter.

Parameters:

newPath - String, type the new path to use. This is a required parameter if the FIX option was chosen.

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