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

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

public class DefineProjection
extends AbstractGPTool

This tool overwrites the coordinate system information (map projection and datum) stored with a dataset. The only use for this tool is for datsets that have an unknown or incorrect coordinate system defined. The Define Projection 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
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 - dataset or feature class whose projection is to be defined.
coorSystem - 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.
Method Detail

getInDataset

public Object getInDataset()
Returns the Input Dataset or Feature Class parameter of this tool . This parameter is dataset 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 dataset or feature class whose projection is to be defined. This is a required parameter.

Parameters:
inDataset - dataset or feature class whose projection is to be defined.

getCoorSystem

public Object getCoorSystem()
Returns the 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 Coordinate System

setCoorSystem

public void setCoorSystem(Object coorSystem)
Sets the 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:
coorSystem - 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.

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