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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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. Valid input is standalone feature class, feature dataset or raster catalog which have low resolution spatial reference and are stored in a current version of a Personal or ArcSDE Geodatabase. The origin and precision of the high precision spatial reference grid will "mesh" with the existing low precision grid. This is to say that for each point of the original low precision spatial reference grid there is a point in the new high precision spatial reference grid. Coordinate values will not be affected by the upgrade. For more information, see The Upgrade Spatial Reference tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• To determine the Geodatabase version right click the geodatabase and select "Properties...", the "Upgrade Status" section will show the ArcGIS release that Geodatabase corresponds to. If version number is less than 9.2, you can use the "Upgrade Geodatabase" button to get the geodatabase to the ArcGIS release that you are using.
• To determine if a dataset (feature class, feature dataset, or raster catalog) is high precision, right click the dataset, and click the General tab. In the Geometry Properties, youll see either "Data Storage : High Precision" or "Low Precision". Datasets stored in a File Geodatabase are always high precision.
• Individual feature classes within a feature dataset cannot be upgraded individually as they inherit their spatial reference from the feature dataset. In order to upgrade them, upgrade the feature dataset's spatial reference which means the spatial reference of all the feature classes in the dataset will be upgraded.
• The valid list of upgrade resolutions are based on the input (low precision) resolution divided by the following numbers: 1, 2, 4, 8, 16, 32, 64, 128, 256, 512.
• In scripting and command line the upgrade resolution from the valid list that is closest to the value specified will be used.
• ArcCatalog's Copy/Paste functionality automatically upgrades the spatial reference of datasets when the output is a 9.2 (and later) Geodatabase.
• When used on a feature dataset, the M Resolution will not be applied to feature classes contained within a feature dataset. The M Resolution values of the feature classes within the feature dataset will be unchanged.
• The XY tolerance property of the upgraded spatial reference will be 2.0 * (9.1 dataset resolution).

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 - Feature Class | Feature Dataset | Raster Catalog, valid input is a feature class, feature dataset or raster catalog which has a low resolution spatial reference and are stored in a 9.2 or current version of a file or personal or ArcSDE geodatabase.

Method Detail

getInputDataset

public Object getInputDataset()

Returns the Input Dataset parameter of this tool . This parameter is Feature Class | Feature Dataset | Raster Catalog, valid input is a feature class, feature dataset or raster catalog which has a low resolution spatial reference and are stored in a 9.2 or current version of a file or 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 Feature Class | Feature Dataset | Raster Catalog, valid input is a feature class, feature dataset or raster catalog which has a low resolution spatial reference and are stored in a 9.2 or current version of a file or personal or ArcSDE geodatabase. This is a required parameter.

Parameters:

inputDataset - Feature Class | Feature Dataset | Raster Catalog, valid input is a feature class, feature dataset or raster catalog which has a low resolution spatial reference and are stored in a 9.2 or current version of a file or personal or ArcSDE geodatabase.

getXyResolution

public double getXyResolution()

Returns the XY Resolution parameter of this tool . This parameter is Double, the value to which the dataset's xy resolution will be changed as part of the upgrade. The maximum or largest value is the same as the current xy resolution. The default value is approximately 0.1 millimeter on the earth's surface. 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 Double, the value to which the dataset's xy resolution will be changed as part of the upgrade. The maximum or largest value is the same as the current xy resolution. The default value is approximately 0.1 millimeter on the earth's surface. This is an optional parameter.

Parameters:

xyResolution - Double, the value to which the dataset's xy resolution will be changed as part of the upgrade. The maximum or largest value is the same as the current xy resolution. The default value is approximately 0.1 millimeter on the earth's surface.

getZResolution

public double getZResolution()

Returns the Z Resolution parameter of this tool . This parameter is Double, the value to which the dataset's z resolution will be changed as part of the upgrade. The maximum or largest value is the same as the dataset's current z resolution (before being upgraded). 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 Double, the value to which the dataset's z resolution will be changed as part of the upgrade. The maximum or largest value is the same as the dataset's current z resolution (before being upgraded). By default the resolution will be improved by a factor of 4. This is an optional parameter.

Parameters:

zResolution - Double, the value to which the dataset's z resolution will be changed as part of the upgrade. The maximum or largest value is the same as the dataset's current z resolution (before being upgraded). 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 Double, the value to which the dataset's m resolution will be changed as part of the upgrade. The maximum or largest value is the same as the dataset's current m resolution (before being upgraded). 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 Double, the value to which the dataset's m resolution will be changed as part of the upgrade. The maximum or largest value is the same as the dataset's current m resolution (before being upgraded). By default the resolution will be improved by a factor of 4. This is an optional parameter.

Parameters:

mResolution - Double, the value to which the dataset's m resolution will be changed as part of the upgrade. The maximum or largest value is the same as the dataset's current m resolution (before being upgraded). 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