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

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

public class SelectData
extends AbstractGPTool

The Select Data tool selects data in a parent data element such as a folder, geodatabase, feature dataset, or coverage. The Select Data 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
SelectData()
          Creates the Select Data tool with defaults.
SelectData(Object inDataelement)
          Creates the Select Data tool with the required parameters.
 
Method Summary
 Object getInDataelement()
          Returns the Input Data Element parameter of this tool .
 String getOutDataelement()
          Returns the Child Data Element parameter of this tool .
 Object getOutDataelementDerived()
          Returns the Output data element 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 setInDataelement(Object inDataelement)
          Sets the Input Data Element parameter of this tool .
 void setOutDataelement(String outDataelement)
          Sets the Child Data Element 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

SelectData

public SelectData()
Creates the Select Data tool with defaults.

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


SelectData

public SelectData(Object inDataelement)
Creates the Select Data 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:
inDataelement - the input data element can be a folder, geodatabase, feature dataset, or coverage.
Method Detail

getInDataelement

public Object getInDataelement()
Returns the Input Data Element parameter of this tool . This parameter is the input data element can be a folder, geodatabase, feature dataset, or coverage. This is a required parameter.

Returns:
the Input Data Element

setInDataelement

public void setInDataelement(Object inDataelement)
Sets the Input Data Element parameter of this tool . This parameter is the input data element can be a folder, geodatabase, feature dataset, or coverage. This is a required parameter.

Parameters:
inDataelement - the input data element can be a folder, geodatabase, feature dataset, or coverage.

getOutDataelement

public String getOutDataelement()
Returns the Child Data Element parameter of this tool . This parameter is the child data element is contained by the input data element. Once the input data element is specified, the child data element control contains a drop-down list of the data elements contained in the input data element. For example, if the input is a feature dataset, all the feature classes within the feature dataset are included in the drop-down list. A single element is selected from this list. This is an optional parameter.

Returns:
the Child Data Element

setOutDataelement

public void setOutDataelement(String outDataelement)
Sets the Child Data Element parameter of this tool . This parameter is the child data element is contained by the input data element. Once the input data element is specified, the child data element control contains a drop-down list of the data elements contained in the input data element. For example, if the input is a feature dataset, all the feature classes within the feature dataset are included in the drop-down list. A single element is selected from this list. This is an optional parameter.

Parameters:
outDataelement - the child data element is contained by the input data element. Once the input data element is specified, the child data element control contains a drop-down list of the data elements contained in the input data element. For example, if the input is a feature dataset, all the feature classes within the feature dataset are included in the drop-down list. A single element is selected from this list.

getOutDataelementDerived

public Object getOutDataelementDerived()
Returns the Output data element parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output data element

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