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, including the datum or spheroid, and defines the location of points on a planar surface. If you want to change projections of several datasets then use this tool. For a single dataset use Project tool instead. The output datasets go to the location set in output workspace parameter. The Batch Project tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• Any valid input to Project tool, such as all input feature classes; and/or feature datasets; , is also valid for this tool. See Project tool help; for more information.
• Although both the Output Coordinate System and Template Dataset are optinal parameters, one of them must be entered. Keeping both of these parameters empty will fail the tool execution.
• If you have a feature class undefined or unknown projection then use the Define Project; tool first.
• The name of the output feature classes will be based on the name of the input feature classes. For instance, if the input is c:\myworkspace\Gondor.shp, the output feature class will be named Gondor. If the name already exists in the output workspace, a number will be appended (for example, _1) to the end to make it unique in the output workspace (Gondor_1).
• Projections of some datasets may require transformations. You can use Project tool first in order to find out which transformations to use. For more information on geographic transformations, see Geographic transformation methods;
• For more information on map projections, see An overview of map projections; , and List of supported map projections; For more information on coordinate systems, see About coordinate systems and map projections; About geographic coordinate systems; Learn more about projecting data;
• Learn more about spatial reference and geoprocessing;
• The following environments affect this tool: configKeyword; extent; MDomain; outputCoordinateSystem; outputMFlag; outputZFlag; outputZFlag; scratchWorkspace; spatialGrid1; spatialGrid2; spatialGrid3; workspace; XYDomain; , and ZDomain;

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 - Geodataset, the input feature classes or feature datasets whose coordinates are to be converted.

outputWorkspace - Workspace | Feature Dataset, the output location of each new feature class or feature dataset whose coordinates have been converted.

Method Detail

getInputFeatureClassOrDataset

public Object getInputFeatureClassOrDataset()

Returns the Input Feature Class or Dataset parameter of this tool . This parameter is Geodataset, 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 Geodataset, the input feature classes or feature datasets whose coordinates are to be converted. This is a required parameter.

Parameters:

inputFeatureClassOrDataset - Geodataset, 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 Workspace | Feature Dataset, the output location of each new feature class or feature dataset whose coordinates have been converted. 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 Workspace | Feature Dataset, the output location of each new feature class or feature dataset whose coordinates have been converted. This is a required parameter.

Parameters:

outputWorkspace - Workspace | Feature Dataset, the output location of each new feature class or feature dataset whose coordinates have been converted.

getOutputCoordinateSystem

public Object getOutputCoordinateSystem()

Returns the Output Coordinate System parameter of this tool . This parameter is Coordinate System, name of the coordinate system to be applied to each input dataset or feature class. 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 Coordinate System, name of the coordinate system to be applied to each input dataset or feature class. This is an optional parameter.

Parameters:

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

getTemplateDataset

public Object getTemplateDataset()

Returns the Template dataset parameter of this tool . This parameter is Geodataset, a feature class or feature dataset whose coordinate system is used during project. 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 Geodataset, a feature class or feature dataset whose coordinate system is used during project. This is an optional parameter.

Parameters:

templateDataset - Geodataset, a feature class or feature dataset whose coordinate system is used during project.

getTransformation

public String getTransformation()

Returns the Transformation parameter of this tool . This parameter is String, a local datum aligns its spheroid to closely fit the earth's surface in a particular area. This is an optional parameter.

Returns:

the Transformation

setTransformation

public void setTransformation(String transformation)

Sets the Transformation parameter of this tool . This parameter is String, a local datum aligns its spheroid to closely fit the earth's surface in a particular area. This is an optional parameter.

Parameters:

transformation - String, a local datum aligns its spheroid to closely fit the earth's surface in a particular area.

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