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

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

All Implemented Interfaces:

GPTool

public class BatchProject
extends AbstractGPTool

Changes the coordinate system of a set of input feature classes or feature datasets to a common coordinate system. To change the coordinate system of a single feature class or dataset use the Project tool. The Batch Project tool is contained in the Data Management Tools tool box.

Usage tips:

• Any valid inputs to the tool, such as all feature classes or feature datasets, are also valid inputs for this tool.
• Although both the Output Coordinate System and Template Dataset are optional parameters, one of them must be entered. Keeping both of these parameters empty will cause tool execution to fail.
• As the tool does not validate whether a transformation is required, use the tool first with one of the inputs to determine whether any transformation is required. The drop-down list of the Project tool's Geographic Transformation parameter shows which transformations (if any) are valid.
• 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 tool.
• The names of the output feature classes will be based on the names of the input feature classes. For instance, if the input is C:\myworkspace\Gondor.shp, the output feature class will be named Gondor.shp. If the name already exists in the output workspace, a number will be appended (for example, _1) to the end to make it unique (Gondor_1.shp) in the output workspace.

Field Summary

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

vals

Constructor Summary

BatchProject()
Creates the Batch Project tool with defaults.

BatchProject(Object inputFeatureClassOrDataset, Object outputWorkspace)
Creates the Batch Project tool with the required parameters.

Method Summary

Object	getDerivedOutput() Returns the Derived Output parameter of this tool (Read only).
Object	getInputFeatureClassOrDataset() Returns the Input Feature Class or Dataset parameter of this tool .
Object	getOutputCoordinateSystem() Returns the Output Coordinate System parameter of this tool .
Object	getOutputWorkspace() Returns the Output Workspace parameter of this tool .
Object	getTemplateDataset() Returns the Template dataset 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.
String	getTransformation() Returns the Transformation parameter of this tool .
void	setInputFeatureClassOrDataset(Object inputFeatureClassOrDataset) Sets the Input Feature Class or Dataset parameter of this tool .
void	setOutputCoordinateSystem(Object outputCoordinateSystem) Sets the Output Coordinate System parameter of this tool .
void	setOutputWorkspace(Object outputWorkspace) Sets the Output Workspace parameter of this tool .
void	setTemplateDataset(Object templateDataset) Sets the Template dataset parameter of this tool .
void	setTransformation(String transformation) Sets the Transformation 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

BatchProject

public BatchProject()

Creates the Batch Project tool with defaults.

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

BatchProject

public BatchProject(Object inputFeatureClassOrDataset,
                    Object outputWorkspace)

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

inputFeatureClassOrDataset - the input feature classes or feature datasets whose coordinates are to be converted.

outputWorkspace - the location of each new output feature class or feature dataset.

Method Detail

getInputFeatureClassOrDataset

public Object getInputFeatureClassOrDataset()

Returns the Input Feature Class or Dataset parameter of this tool . This parameter is the input feature classes or feature datasets whose coordinates are to be converted. This is a required parameter.

Returns:

the Input Feature Class or Dataset

setInputFeatureClassOrDataset

public void setInputFeatureClassOrDataset(Object inputFeatureClassOrDataset)

Sets the Input Feature Class or Dataset parameter of this tool . This parameter is the input feature classes or feature datasets whose coordinates are to be converted. This is a required parameter.

Parameters:

inputFeatureClassOrDataset - the input feature classes or feature datasets whose coordinates are to be converted.

getOutputWorkspace

public Object getOutputWorkspace()

Returns the Output Workspace parameter of this tool . This parameter is the location of each new output feature class or feature dataset. This is a required parameter.

Returns:

the Output Workspace

setOutputWorkspace

public void setOutputWorkspace(Object outputWorkspace)

Sets the Output Workspace parameter of this tool . This parameter is the location of each new output feature class or feature dataset. This is a required parameter.

Parameters:

outputWorkspace - the location of each new output feature class or feature dataset.

getOutputCoordinateSystem

public Object getOutputCoordinateSystem()

Returns the Output Coordinate System parameter of this tool . This parameter is the coordinate system to be used to project the inputs. 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 an optional parameter.

Returns:

the Output Coordinate System

setOutputCoordinateSystem

public void setOutputCoordinateSystem(Object outputCoordinateSystem)

Sets the Output Coordinate System parameter of this tool . This parameter is the coordinate system to be used to project the inputs. 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 an optional parameter.

Parameters:

outputCoordinateSystem - the coordinate system to be used to project the inputs. 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.

getTemplateDataset

public Object getTemplateDataset()

Returns the Template dataset parameter of this tool . This parameter is the feature class or the feature dataset used to specify the output coordinate system used for projection. This is an optional parameter.

Returns:

the Template dataset

setTemplateDataset

public void setTemplateDataset(Object templateDataset)

Sets the Template dataset parameter of this tool . This parameter is the feature class or the feature dataset used to specify the output coordinate system used for projection. This is an optional parameter.

Parameters:

templateDataset - the feature class or the feature dataset used to specify the output coordinate system used for projection.

getTransformation

public String getTransformation()

Returns the Transformation parameter of this tool . This parameter is name of the geographic transformation to be applied to convert data between two geographic coordinate systems (datums). This is an optional parameter.

Returns:

the Transformation

setTransformation

public void setTransformation(String transformation)

Sets the Transformation parameter of this tool . This parameter is name of the geographic transformation to be applied to convert data between two geographic coordinate systems (datums). This is an optional parameter.

Parameters:

transformation - name of the geographic transformation to be applied to convert data between two geographic coordinate systems (datums).

getDerivedOutput

public Object getDerivedOutput()

Returns the Derived Output parameter of this tool (Read only). This is an derived parameter.

Returns:

the Derived Output

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