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

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

All Implemented Interfaces:

GPTool

public class DefineProjection
extends AbstractGPTool

Records the The Define Projection tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• This tool supports coordinate transformation using either of two projection systems. It can be used to define a feature class as a spherical coordinate system with angular units (such as Geographic) or a planar coordinate system with linear units. Most geoprocessing tools assume you have a planar, two-dimensional feature class. So if your feature class is in a geographic coordinate system; in Decimal Degrees (DD, angular units), use the Project tool to project your feature class to any suitable projected coordinate system in linear units (meters or feet).
• This command can be used if the input dataset or feature class does not have a projection defined. If the input dataset or feature class has a projection defined, a warning will be raised but the tool will execute successfully.
• The coordinate system information of the input is created or modified by this tool. No separate output feature class will be created.
• If the input dataset or feature class doesn't have a projection defined, the coordinate system will be listed as Unknown on the dialog box.
• If the input dataset or feature class has a coordinate system defined, use the Project; tool to modify it.
• Use the Spatial Reference Properties dialog box to select a coordinate system definition from either an existing definition list or from another dataset or to create a new coordinate system definition.
• All feature classes in a geodatabase feature dataset will be in the same coordinate system. The coordinate system for a geodatabase dataset should be determined when it is created. Once it contains feature classes, its coordinate system can't be changed.
• For more information on geographic transformations, see Geographic transformation methods;
• The environment setting that affects this tool is: configKeyword; extent; outputCoordinateSystem; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

DefineProjection()
Creates the Define Projection tool with defaults.

DefineProjection(Object inDataset, Object coorSystem)
Creates the Define Projection tool with the required parameters.

Method Summary

Object	getCoorSystem() Returns the Coordinate System parameter of this tool .
Object	getInDataset() Returns the Input Dataset or Feature Class parameter of this tool .
Object	getOutDataset() Returns the Output Dataset or Feature Class 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.
void	setCoorSystem(Object coorSystem) Sets the Coordinate System parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Dataset or Feature Class 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

DefineProjection

public DefineProjection()

Creates the Define Projection tool with defaults.

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

DefineProjection

public DefineProjection(Object inDataset,
                        Object coorSystem)

Creates the Define Projection 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:

inDataset - Feature Layer | Geodataset, or feature class whose projection is to be defined.

coorSystem - Coordinate System, name of the coordinate system to be applied to the input dataset or feature class.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Dataset or Feature Class parameter of this tool . This parameter is Feature Layer | Geodataset, or feature class whose projection is to be defined. This is a required parameter.

Returns:

the Input Dataset or Feature Class

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Dataset or Feature Class parameter of this tool . This parameter is Feature Layer | Geodataset, or feature class whose projection is to be defined. This is a required parameter.

Parameters:

inDataset - Feature Layer | Geodataset, or feature class whose projection is to be defined.

getCoorSystem

public Object getCoorSystem()

Returns the Coordinate System parameter of this tool . This parameter is Coordinate System, name of the coordinate system to be applied to the input dataset or feature class. This is a required parameter.

Returns:

the Coordinate System

setCoorSystem

public void setCoorSystem(Object coorSystem)

Sets the Coordinate System parameter of this tool . This parameter is Coordinate System, name of the coordinate system to be applied to the input dataset or feature class. This is a required parameter.

Parameters:

coorSystem - Coordinate System, name of the coordinate system to be applied to the input dataset or feature class.

getOutDataset

public Object getOutDataset()

Returns the Output Dataset or Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Dataset or Feature Class

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