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

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

public class UpgradeSpatialReference
extends AbstractGPTool

Upgrades a low precision dataset's spatial reference to high precision. The Upgrade Spatial Reference tool is contained in the Data Management Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
UpgradeSpatialReference()
          Creates the Upgrade Spatial Reference tool with defaults.
UpgradeSpatialReference(Object inputDataset)
          Creates the Upgrade Spatial Reference tool with the required parameters.
 
Method Summary
 Object getInputDataset()
          Returns the Input Dataset parameter of this tool .
 double getMResolution()
          Returns the M Resolution parameter of this tool .
 Object getOutputDataset()
          Returns the Output Dataset parameter of this tool (Read only).
 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.
 double getXyResolution()
          Returns the XY Resolution parameter of this tool .
 double getZResolution()
          Returns the Z Resolution parameter of this tool .
 void setInputDataset(Object inputDataset)
          Sets the Input Dataset parameter of this tool .
 void setMResolution(double mResolution)
          Sets the M Resolution parameter of this tool .
 void setXyResolution(double xyResolution)
          Sets the XY Resolution parameter of this tool .
 void setZResolution(double zResolution)
          Sets the Z Resolution 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

UpgradeSpatialReference

public UpgradeSpatialReference()
Creates the Upgrade Spatial Reference tool with defaults.

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


UpgradeSpatialReference

public UpgradeSpatialReference(Object inputDataset)
Creates the Upgrade Spatial Reference 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:
inputDataset - the input dataset whose spatial reference precision will be upgraded. Valid input is a feature class, feature dataset, or raster catalog with a low resolution spatial reference, stored in a 9.2 or current version personal or ArcSDE geodatabase.
Method Detail

getInputDataset

public Object getInputDataset()
Returns the Input Dataset parameter of this tool . This parameter is the input dataset whose spatial reference precision will be upgraded. Valid input is a feature class, feature dataset, or raster catalog with a low resolution spatial reference, stored in a 9.2 or current version personal or ArcSDE geodatabase. This is a required parameter.

Returns:
the Input Dataset

setInputDataset

public void setInputDataset(Object inputDataset)
Sets the Input Dataset parameter of this tool . This parameter is the input dataset whose spatial reference precision will be upgraded. Valid input is a feature class, feature dataset, or raster catalog with a low resolution spatial reference, stored in a 9.2 or current version personal or ArcSDE geodatabase. This is a required parameter.

Parameters:
inputDataset - the input dataset whose spatial reference precision will be upgraded. Valid input is a feature class, feature dataset, or raster catalog with a low resolution spatial reference, stored in a 9.2 or current version personal or ArcSDE geodatabase.

getXyResolution

public double getXyResolution()
Returns the XY Resolution parameter of this tool . This parameter is the value to which the dataset's XY Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current XY Resolution. This is an optional parameter.

Returns:
the XY Resolution

setXyResolution

public void setXyResolution(double xyResolution)
Sets the XY Resolution parameter of this tool . This parameter is the value to which the dataset's XY Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current XY Resolution. This is an optional parameter.

Parameters:
xyResolution - the value to which the dataset's XY Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current XY Resolution.

getZResolution

public double getZResolution()
Returns the Z Resolution parameter of this tool . This parameter is the value to which the dataset's Z Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current Z Resolution. By default, the resolution will be improved by a factor of 4. This is an optional parameter.

Returns:
the Z Resolution

setZResolution

public void setZResolution(double zResolution)
Sets the Z Resolution parameter of this tool . This parameter is the value to which the dataset's Z Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current Z Resolution. By default, the resolution will be improved by a factor of 4. This is an optional parameter.

Parameters:
zResolution - the value to which the dataset's Z Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current Z Resolution. By default, the resolution will be improved by a factor of 4.

getMResolution

public double getMResolution()
Returns the M Resolution parameter of this tool . This parameter is the value to which the dataset's M Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current M Resolution. By default, the resolution will be improved by a factor of 4. This is an optional parameter.

Returns:
the M Resolution

setMResolution

public void setMResolution(double mResolution)
Sets the M Resolution parameter of this tool . This parameter is the value to which the dataset's M Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current M Resolution. By default, the resolution will be improved by a factor of 4. This is an optional parameter.

Parameters:
mResolution - the value to which the dataset's M Resolution will be changed as part of the upgrade. The maximum value is the same as the dataset's current M Resolution. By default, the resolution will be improved by a factor of 4.

getOutputDataset

public Object getOutputDataset()
Returns the Output Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Dataset

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