com.esri.arcgis.geoprocessing.tools.analysistools
Class Select

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.Select

All Implemented Interfaces:

GPTool

public class Select
extends AbstractGPTool

Extracts features from an input The Select tool is contained in the Analysis Tools tool box.

Software restrictions: none

Usage tips:

• If no Expression is included, then all features will be included in the output feature class.
• For details on the syntax for the Expression parameter, see Building an SQL Expression; or SQL Reference;
• The following environment settings affect this tool: Coordinate system; Extent; XY Tolerance; Z Tolerance; M Tolerance; XY Resolution; Z Resolution; M Resolution; Output XY domain; Output Z domain; Output M , domain; Output has M values; Output has Z values; Default Z value; Configuration keyword; Output Spatial Grid;

Field Summary

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

vals

Constructor Summary

Select()
Creates the Select tool with defaults.

Select(Object inFeatures, Object outFeatureClass)
Creates the Select tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class 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.
Object	getWhereClause() Returns the Expression parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression 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

Select

public Select()

Creates the Select tool with defaults.

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

Select

public Select(Object inFeatures,
              Object outFeatureClass)

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

inFeatures - Feature Layer, the input feature class or layer from which features are selected.

outFeatureClass - Feature Class, the output feature class to be created. This feature class will contain all the features from the input if no expression is specified.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the input feature class or layer from which features are selected. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is Feature Layer, the input feature class or layer from which features are selected. This is a required parameter.

Parameters:

inFeatures - Feature Layer, the input feature class or layer from which features are selected.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to be created. This feature class will contain all the features from the input if no expression is specified. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to be created. This feature class will contain all the features from the input if no expression is specified. This is a required parameter.

Parameters:

outFeatureClass - Feature Class, the output feature class to be created. This feature class will contain all the features from the input if no expression is specified.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is SQL Expression, for more information on SQL syntax and how it differs between data sources, see This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is SQL Expression, for more information on SQL syntax and how it differs between data sources, see This is an optional parameter.

Parameters:

whereClause - SQL Expression, for more information on SQL syntax and how it differs between data sources, see

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