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

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

public class SelectLayerByAttribute
extends AbstractGPTool

Adds, updates, or removes a selection on a layer or table view based on an attribute query. The Select Layer By Attribute 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
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 - the feature layer or table view to which the selection will be applied. the input can be a layer or table view in the ArcMap table of contents, or a layer or table view created in ArcCatalog or in scripts using the Make Feature Layer or Make Table View tools.
Method Detail

getInLayerOrView

public Object getInLayerOrView()
Returns the Layer Name or Table View parameter of this tool . This parameter is the feature layer or table view to which the selection will be applied. the input can be a layer or table view in the ArcMap table of contents, or a layer or table view created in ArcCatalog or in scripts using the Make Feature Layer or Make Table View tools. 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 the feature layer or table view to which the selection will be applied. the input can be a layer or table view in the ArcMap table of contents, or a layer or table view created in ArcCatalog or in scripts using the Make Feature Layer or Make Table View tools. This is a required parameter.

Parameters:
inLayerOrView - the feature layer or table view to which the selection will be applied. the input can be a layer or table view in the ArcMap table of contents, or a layer or table view created in ArcCatalog or in scripts using the Make Feature Layer or Make Table View tools.

getSelectionType

public String getSelectionType()
Returns the Selection type parameter of this tool . This parameter is 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 determines how the selection will be applied and what to do if a selection already exists. This is an optional parameter.

Parameters:
selectionType - 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 a Structured Query Language (SQL) expression used to select a subset of records. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference. This is an optional parameter.

Returns:
the Expression

setWhereClause

public void setWhereClause(Object whereClause)
Sets the Expression parameter of this tool . This parameter is a Structured Query Language (SQL) expression used to select a subset of records. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference. This is an optional parameter.

Parameters:
whereClause - a Structured Query Language (SQL) expression used to select a subset of records. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference.

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