com.esri.arcgis.geoprocessing.tools.coveragetools
Class Project

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.Project

All Implemented Interfaces:

GPTool

public class Project
extends AbstractGPTool

Changes the coordinate system of your coverage including its datum or spheroid. The Project tool is contained in the Coverage Tools tool box.

Usage tips:

• This tool can convert a dataset from a spherical coordinate system with angular units (such as Geographic) to a planar coordinate system with linear units. Most Coverage tools, among them and , assume you have a planar, two-dimensional dataset. So if your dataset is in a geographic coordinate system in decimal degrees (DD, angular units), the Project tool projects your dataset to any suitable projected coordinate system in linear units (meters or feet).
• A coverage can maintain an explicit definition of the coordinate system in which it is stored. This can be created using the tool. If not defined, the projection will be listed as unknown.
• Output projection information can be specified using a Project File or from an empty output coverage. The Project File must contain both input and output projection definitions. Use of a Project File will override any projection information stored in the data's PRJ file.
• Clarke 1866 is the default spheroid if it is not inherent to the projection (such as NEWZEALAND_GRID).
• Do not name an output file the same as the Project File, even if the Project File has a .prj extension.
• When projecting a coverage, the Output Coverage can be an existing, empty coverage. The coordinates of the Input Coverage will be projected into the coordinate system defined by the PRJ file of the Output Coverage.
• Depending on the input and output projection definitions, an arc in the input coverage may need to be clipped into more than one segment while the output coverage is being generated. This will occur whenever an arc encounters the horizon line or crosses the line of longitude opposite the central meridian.Whenever a vertex is encountered that cannot be projected, the previous vertex will be interpreted as the end of an arc, and the partially projected arc will be written to the output. It is possible for an arc to be split into several arcs if subsequent vertices are encountered that can be projected. In this case, the output retains the original IDs so attributes can be relinked. Examine this illustration; arcs 2 and 3 will be clipped by the horizon during projection of the line. The output coverage will contain one arc 2 but two arc 3s. In cases such as these, Project will generate arcs having duplicate User-IDs.
• If regions exist in the input coverage, regions in the output coverage will be preliminary regions. When the Build tool is used to re-create the polygon topology, region topology will also be re-created.
• Learn about
• For tables of predefined geographic coordinate system, projected coordinate system, and geographic (datum) transformations, see .

Field Summary

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

vals

Constructor Summary

Project()
Creates the Project tool with defaults.

Project(Object inCover, Object outCover, Object projectionFile)
Creates the Project tool with the required parameters.

Method Summary

Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
Object	getProjectionFile() Returns the Projection File 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	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setProjectionFile(Object projectionFile) Sets the Projection File 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

Project

public Project()

Creates the Project tool with defaults.

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

Project

public Project(Object inCover,
               Object outCover,
               Object projectionFile)

Creates the Project 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:

inCover - the coverage whose coordinates are to be converted.

outCover - the output coverage whose coordinates have been converted to the new coordinate system. The output coverage may exist, but must be empty.

projectionFile - the name of a text file defining the input and output projection parameters.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage whose coordinates are to be converted. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage whose coordinates are to be converted. This is a required parameter.

Parameters:

inCover - the coverage whose coordinates are to be converted.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the output coverage whose coordinates have been converted to the new coordinate system. The output coverage may exist, but must be empty. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the output coverage whose coordinates have been converted to the new coordinate system. The output coverage may exist, but must be empty. This is a required parameter.

Parameters:

outCover - the output coverage whose coordinates have been converted to the new coordinate system. The output coverage may exist, but must be empty.

getProjectionFile

public Object getProjectionFile()

Returns the Projection File parameter of this tool . This parameter is the name of a text file defining the input and output projection parameters. This is a required parameter.

Returns:

the Projection File

setProjectionFile

public void setProjectionFile(Object projectionFile)

Sets the Projection File parameter of this tool . This parameter is the name of a text file defining the input and output projection parameters. This is a required parameter.

Parameters:

projectionFile - the name of a text file defining the input and output projection parameters.

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