com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class Project
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.datamanagementtools.Project
- All Implemented Interfaces:
- GPTool
public class Project
- extends AbstractGPTool
Creates a new dataset or feature class with the coordinate system specified.
The Project tool is contained in the Data Management Tools tool box.
Usage tips:
- A feature class or dataset with an undefined or unknown coordinate system must first have its coordinate system defined using the tool before it can be used with the Project tool.
- All feature classes, feature layers, shapefiles, or feature datasets are valid inputs to this tool. Coverages, VPF Coverages, raster datasets, and raster catalogs are not supported by this tool. For projecting a Coverage use the tool in Coverage toolbox. Use the tool to project raster datasets.
- When the input and output coordinate systems have different datum, one or more geographic transformations may be required. The Geographic Transformation parameter is initially optional. However, when any projection requires a transformation, the parameter becomes required and a drop-down list will show valid transformations to select from.For example, a geographic transformation is not required when projecting from GCS_North_American_1983 to NAD_1983_UTM_Zone_12N because both the input and output coordinate systems have a NAD_1983 datum. However, projecting from GCS_North_American_1983 to WGS_1984_UTM_Zone_12N requires a geographic transformation because the input coordinate system uses the NAD_1983 datum while the output coordinate system uses the WGS_1984 datum.
- Although in-memory feature classes are valid input to the tool, output cannot be in the in_memory workspace.
- Network datasets must be rebuilt if a feature class participating in the network is projected.
- If the input is a feature dataset containing a topology, the entire extent of the topology in the output feature dataset will need to be re-validated.
- When using this tool to project data participating in relationship classes (as with feature-linked annotation in a feature dataset), relationship classes are maintained and carried over to the output feature class, with the exception of relates to stand-alone tables.
- Depending on the input and output projection definitions, a line in the input feature class may be split into more than one segment when the output feature class is being written. This occurs whenever a line encounters the horizon line or crosses the line of longitude opposite the central meridian.
- Features that encouter the horizon of the projected coordinate system will get clipped.
- When working with geographic transformations, if the direction is not indicated, geoprocessing tools will handle the directionality automatically. For example, if converting data from WGS 1984 to NAD 1927, you can pick a transformation called NAD_1927_to_WGS_1984_3 and the software will apply it correctly.
- When running this tool in batch mode, you need to double-click the transformation column to check if transformation is required.
Constructor Summary |
Project()
Creates the Project tool with defaults. |
Project(java.lang.Object inDataset,
java.lang.Object outDataset,
java.lang.Object outCoorSystem)
Creates the Project tool with the required parameters. |
Method Summary |
java.lang.Object |
getInCoorSystem()
Returns the Input Coordinate System parameter of this tool . |
java.lang.Object |
getInDataset()
Returns the Input Dataset or Feature Class parameter of this tool . |
java.lang.Object |
getOutCoorSystem()
Returns the Output Coordinate System parameter of this tool . |
java.lang.Object |
getOutDataset()
Returns the Output Dataset or Feature Class parameter of this tool . |
java.lang.String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
java.lang.String |
getToolboxName()
Returns the name of the tool box containing this tool. |
java.lang.String |
getToolName()
Returns the name of this tool. |
java.lang.Object |
getTransformMethod()
Returns the Geographic Transformation parameter of this tool . |
void |
setInCoorSystem(java.lang.Object inCoorSystem)
Sets the Input Coordinate System parameter of this tool . |
void |
setInDataset(java.lang.Object inDataset)
Sets the Input Dataset or Feature Class parameter of this tool . |
void |
setOutCoorSystem(java.lang.Object outCoorSystem)
Sets the Output Coordinate System parameter of this tool . |
void |
setOutDataset(java.lang.Object outDataset)
Sets the Output Dataset or Feature Class parameter of this tool . |
void |
setTransformMethod(java.lang.Object transformMethod)
Sets the Geographic Transformation parameter of this tool . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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(java.lang.Object inDataset,
java.lang.Object outDataset,
java.lang.Object outCoorSystem)
- 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:
inDataset
- the feature class, feature layer, or feature dataset to be projected.outDataset
- the new feature dataset or feature class that has the coordinate system specified in the output coordinate system parameter.outCoorSystem
- valid values are a file with a .prj extension (.prj files shipped with ArcGIS are available at the ArcGIS installation directory > Coordinate System folder) or a string representation of a coordinate system. This string representation can be generated by adding a coordinate system variable to ModelBuilder, setting the variable's value as desired, then exporting the model to a Python script. The string can then be copied from the Python script.
getInDataset
public java.lang.Object getInDataset()
- Returns the Input Dataset or Feature Class parameter of this tool .
This parameter is the feature class, feature layer, or feature dataset to be projected.
This is a required parameter.
- Returns:
- the Input Dataset or Feature Class
setInDataset
public void setInDataset(java.lang.Object inDataset)
- Sets the Input Dataset or Feature Class parameter of this tool .
This parameter is the feature class, feature layer, or feature dataset to be projected.
This is a required parameter.
- Parameters:
inDataset
- the feature class, feature layer, or feature dataset to be projected.
getOutDataset
public java.lang.Object getOutDataset()
- Returns the Output Dataset or Feature Class parameter of this tool .
This parameter is the new feature dataset or feature class that has the coordinate system specified in the output coordinate system parameter.
This is a required parameter.
- Returns:
- the Output Dataset or Feature Class
setOutDataset
public void setOutDataset(java.lang.Object outDataset)
- Sets the Output Dataset or Feature Class parameter of this tool .
This parameter is the new feature dataset or feature class that has the coordinate system specified in the output coordinate system parameter.
This is a required parameter.
- Parameters:
outDataset
- the new feature dataset or feature class that has the coordinate system specified in the output coordinate system parameter.
getOutCoorSystem
public java.lang.Object getOutCoorSystem()
- Returns the Output Coordinate System parameter of this tool .
This parameter is valid values are a file with a .prj extension (.prj files shipped with ArcGIS are available at the ArcGIS installation directory > Coordinate System folder) or a string representation of a coordinate system. This string representation can be generated by adding a coordinate system variable to ModelBuilder, setting the variable's value as desired, then exporting the model to a Python script. The string can then be copied from the Python script.
This is a required parameter.
- Returns:
- the Output Coordinate System
setOutCoorSystem
public void setOutCoorSystem(java.lang.Object outCoorSystem)
- Sets the Output Coordinate System parameter of this tool .
This parameter is valid values are a file with a .prj extension (.prj files shipped with ArcGIS are available at the ArcGIS installation directory > Coordinate System folder) or a string representation of a coordinate system. This string representation can be generated by adding a coordinate system variable to ModelBuilder, setting the variable's value as desired, then exporting the model to a Python script. The string can then be copied from the Python script.
This is a required parameter.
- Parameters:
outCoorSystem
- valid values are a file with a .prj extension (.prj files shipped with ArcGIS are available at the ArcGIS installation directory > Coordinate System folder) or a string representation of a coordinate system. This string representation can be generated by adding a coordinate system variable to ModelBuilder, setting the variable's value as desired, then exporting the model to a Python script. The string can then be copied from the Python script.
getTransformMethod
public java.lang.Object getTransformMethod()
- Returns the Geographic Transformation parameter of this tool .
This parameter is this method can be used for converting data between two geographic coordinate systems or datums. This initially optional parameter may be required if the input and output coordinate systems have different data.
This is an optional parameter.
- Returns:
- the Geographic Transformation
setTransformMethod
public void setTransformMethod(java.lang.Object transformMethod)
- Sets the Geographic Transformation parameter of this tool .
This parameter is this method can be used for converting data between two geographic coordinate systems or datums. This initially optional parameter may be required if the input and output coordinate systems have different data.
This is an optional parameter.
- Parameters:
transformMethod
- this method can be used for converting data between two geographic coordinate systems or datums. This initially optional parameter may be required if the input and output coordinate systems have different data.
getInCoorSystem
public java.lang.Object getInCoorSystem()
- Returns the Input Coordinate System parameter of this tool .
This parameter is the coordinate system of the input feature class or dataset.
This is an optional parameter.
- Returns:
- the Input Coordinate System
setInCoorSystem
public void setInCoorSystem(java.lang.Object inCoorSystem)
- Sets the Input Coordinate System parameter of this tool .
This parameter is the coordinate system of the input feature class or dataset.
This is an optional parameter.
- Parameters:
inCoorSystem
- the coordinate system of the input feature class or dataset.
getToolName
public java.lang.String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public java.lang.String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public java.lang.String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias