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

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

All Implemented Interfaces:

GPTool

public class TableSelect
extends AbstractGPTool

Selects table records matching a Structured Query Language (SQL) expression and writes them to an output table. The Table Select tool is contained in the Analysis Tools tool box.

Usage tips:

• The input can be an INFO, dBASE, or geodatabase table, a feature class, table view, or VPF dataset.
• In the tool dialog, a selection expression can be built with the Query Builder. In scripting, the expression must be manually entered.
• If a table view is used for Input Table and no expression is entered, only the selected records are written to the output table. If a table view is used for input table and an expression is entered, the expression is only executed against the selected records, and the expression-based subset of the selected set is written to the output table.
• If you want to create a table from the table view's selected set of records, use the (management) tool.

Field Summary

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

vals

Constructor Summary

TableSelect()
Creates the Table Select tool with defaults.

TableSelect(Object inTable, Object outTable)
Creates the Table Select tool with the required parameters.

Method Summary

Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutTable() Returns the Output Table 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	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table 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

TableSelect

public TableSelect()

Creates the Table Select tool with defaults.

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

TableSelect

public TableSelect(Object inTable,
                   Object outTable)

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

inTable - the table whose records matching the specified expression will be written to the output table.

outTable - the output table containing records from the input table that match the specified expression.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the table whose records matching the specified expression will be written to the output table. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is the table whose records matching the specified expression will be written to the output table. This is a required parameter.

Parameters:

inTable - the table whose records matching the specified expression will be written to the output table.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the output table containing records from the input table that match the specified expression. This is a required parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(Object outTable)

Sets the Output Table parameter of this tool . This parameter is the output table containing records from the input table that match the specified expression. This is a required parameter.

Parameters:

outTable - the output table containing records from the input table that match the specified expression.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is an SQL expression used to select a subset of features. 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 an SQL expression used to select a subset of features. 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 - an SQL expression used to select a subset of features. 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.

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