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

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

All Implemented Interfaces:

GPTool

public class SelectLayerByAttribute
extends AbstractGPTool

Adds, updates, or removes a selection on the layer or table view using an attribute query. The Select Layer By Attribute tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The input must be a feature layer; or a table view; . It cannot be a feature class; or table;
• This tool is not limited to working in ArcMap; it works on layers and table views in ArcCatalog and in scripts. The Make Feature Layer; tool makes a layer for a feature class, and the Make Table View; tool does the equivalent for a table.
• Learn more about working with layers and table views;
• If an extent or a definition query is present on the input layer or table view, only those features or rows that match the extent and/or definition query will be available to be selected.
• The Get Count; tool returns the number of features selected by the tool.
• For details on the syntax for the Expression parameter see: Building an SQL Expression; or SQL Reference;
• No environment settings affect this tool.

Field Summary

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

vals

Constructor Summary

SelectLayerByAttribute()
Creates the Select Layer By Attribute tool with defaults.

SelectLayerByAttribute(Object inLayerOrView)
Creates the Select Layer By Attribute tool with the required parameters.

Method Summary

Object	getInLayerOrView() Returns the Layer Name or Table View parameter of this tool .
Object	getOutLayerOrView() Returns the Output Layer Name parameter of this tool (Read only).
String	getSelectionType() Returns the Selection type 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	setInLayerOrView(Object inLayerOrView) Sets the Layer Name or Table View parameter of this tool .
void	setSelectionType(String selectionType) Sets the Selection type 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

SelectLayerByAttribute

public SelectLayerByAttribute()

Creates the Select Layer By Attribute tool with defaults.

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

SelectLayerByAttribute

public SelectLayerByAttribute(Object inLayerOrView)

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

inLayerOrView - Table View, the feature layer or table view to which the selection will be applied. This can be a layer or table in ArcMap or a layer or table view created by Make Layer or Make Table View in ArcCatalog or in a script.

Method Detail

getInLayerOrView

public Object getInLayerOrView()

Returns the Layer Name or Table View parameter of this tool . This parameter is Table View, the feature layer or table view to which the selection will be applied. This can be a layer or table in ArcMap or a layer or table view created by Make Layer or Make Table View in ArcCatalog or in a script. This is a required parameter.

Returns:

the Layer Name or Table View

setInLayerOrView

public void setInLayerOrView(Object inLayerOrView)

Sets the Layer Name or Table View parameter of this tool . This parameter is Table View, the feature layer or table view to which the selection will be applied. This can be a layer or table in ArcMap or a layer or table view created by Make Layer or Make Table View in ArcCatalog or in a script. This is a required parameter.

Parameters:

inLayerOrView - Table View, the feature layer or table view to which the selection will be applied. This can be a layer or table in ArcMap or a layer or table view created by Make Layer or Make Table View in ArcCatalog or in a script.

getSelectionType

public String getSelectionType()

Returns the Selection type parameter of this tool . This parameter is String, determines how the selection will be applied and what to do if a selection already exists. This is an optional parameter.

Returns:

the Selection type

setSelectionType

public void setSelectionType(String selectionType)

Sets the Selection type parameter of this tool . This parameter is String, determines how the selection will be applied and what to do if a selection already exists. This is an optional parameter.

Parameters:

selectionType - String, determines how the selection will be applied and what to do if a selection already exists.

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

getOutLayerOrView

public Object getOutLayerOrView()

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

Returns:

the Output Layer Name

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