com.esri.arcgis.geoprocessing.tools.samples
Class BatchDefine

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

public class BatchDefine
extends AbstractGPTool

Records the coordinate system information for the specified input datasets including any associated projection parameters, datum, or spheroid. It creates or modifies the dataset's projection parameters. This tool supports coordinate transformation using either of two projection systems. It can be used to define a dataset as a spherical coordinate system with angular units, such as Geographic, or a planar coordinate system with linear units. Most geoprocessing tools assume you have a planar, two-dimensional feature class. If your dataset is in a geographic coordinate system in decimal degrees ([DD], angular units), use the Project tool to project your dataset to any suitable projected coordinate system in linear units (meters or feet). The Batch Define Coordinate System tool is contained in the Samples tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
BatchDefine()
          Creates the Batch Define Coordinate System tool with defaults.
BatchDefine(Object inputDatasets)
          Creates the Batch Define Coordinate System tool with the required parameters.
 
Method Summary
 String getCompleted()
          Returns the Completed parameter of this tool (Read only).
 Object getCoordinateSystem()
          Returns the Coordinate System parameter of this tool .
 String getError()
          Returns the Error parameter of this tool (Read only).
 Object getInputDatasets()
          Returns the Input Datasets 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.
 void setCoordinateSystem(Object coordinateSystem)
          Sets the Coordinate System parameter of this tool .
 void setInputDatasets(Object inputDatasets)
          Sets the Input Datasets parameter of this tool .
 void setTemplateDataset(Object templateDataset)
          Sets the Template Dataset 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

BatchDefine

public BatchDefine()
Creates the Batch Define Coordinate System tool with defaults.

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


BatchDefine

public BatchDefine(Object inputDatasets)
Creates the Batch Define Coordinate System 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:
inputDatasets - null
Method Detail

getInputDatasets

public Object getInputDatasets()
Returns the Input Datasets parameter of this tool . This is a required parameter.

Returns:
the Input Datasets

setInputDatasets

public void setInputDatasets(Object inputDatasets)
Sets the Input Datasets parameter of this tool . This is a required parameter.

Parameters:
inputDatasets - null

getCoordinateSystem

public Object getCoordinateSystem()
Returns the Coordinate System parameter of this tool . This parameter is Coordinate System, name of the coordinate system to be applied to the input datasets. This is an optional parameter.

Returns:
the Coordinate System

setCoordinateSystem

public void setCoordinateSystem(Object coordinateSystem)
Sets the Coordinate System parameter of this tool . This parameter is Coordinate System, name of the coordinate system to be applied to the input datasets. This is an optional parameter.

Parameters:
coordinateSystem - Coordinate System, name of the coordinate system to be applied to the input datasets.

getTemplateDataset

public Object getTemplateDataset()
Returns the Template Dataset parameter of this tool . This parameter is Geodataset, name of the dataset that will be used to select an existing projection definition to be applied to the input datasets. 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, name of the dataset that will be used to select an existing projection definition to be applied to the input datasets. This is an optional parameter.

Parameters:
templateDataset - Geodataset, name of the dataset that will be used to select an existing projection definition to be applied to the input datasets.

getCompleted

public String getCompleted()
Returns the Completed parameter of this tool (Read only). This is an derived parameter.

Returns:
the Completed

getError

public String getError()
Returns the Error parameter of this tool (Read only). This is an derived parameter.

Returns:
the Error

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