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

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

All Implemented Interfaces:

GPTool

public class MakeTableView
extends AbstractGPTool

Creates a The Make Table View tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• This tool is commonly used to create a table view with a selected set of attributes or fields.
• ArcCatalog does not display these table views, but they can be used as inputs to other geoprocessing tools in the current ArcGIS session. Once ArcGIS exits, the tables in memory are removed.
• Table views created in ArcCatalog cannot be used in ArcMap.
• If an SQL expression is used but returns nothing, the output table view will be empty.
• For further details on the syntax for the Expression parameter, see Building an SQL Expression; or SQL Reference;
• Field names can be given a new name by using the Field Information control. The second column on the control lists the existing field names from the input. To rename a field, click the field name and type in a new one.
• The field names will be validated by specifying an input workspace. Thus, if the input is a geodatabase feature class and the output workspace is a folder, the field names may be truncated, since shapefile attributes can only have names of ten characters or less. The new names may be reviewed and altered using the Field Information control.
• A subset of fields can be made visible in the new layer by using the Field Information control. The third column in the control provides a dropdown option to specify whether a field will be visible or hidden in the new layer. The default is TRUE. Selecting FALSE will hide that field. If the feature layer is saved as a new feature class, only the fields listed as visible will appear in the new output.
• New field names defined in Make Table View will be honored in subsequent tools. However, if Make Table View is the last tool in a model, the field names will be obtained from the source table on disk. To maintain new field names, the new table view has to be written out to a new table using Copy Rows or Table to Table tools.
• The split policy option on the Field Information control does not apply to this tool.
• An existing table view will be overwritten if the same table view name is entered.
• Learn more about building an SQL expression;
• No environment settings affect this tool.

Field Summary

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

vals

Constructor Summary

MakeTableView()
Creates the Make Table View tool with defaults.

MakeTableView(Object inTable, Object outView)
Creates the Make Table View tool with the required parameters.

Method Summary

Object	getFieldInfo() Returns the Field Info parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutView() Returns the Table Name 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 .
Object	getWorkspace() Returns the Output Workspace parameter of this tool .
void	setFieldInfo(Object fieldInfo) Sets the Field Info parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutView(Object outView) Sets the Table Name parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression parameter of this tool .
void	setWorkspace(Object workspace) Sets the Output Workspace 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

MakeTableView

public MakeTableView()

Creates the Make Table View tool with defaults.

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

MakeTableView

public MakeTableView(Object inTable,
                     Object outView)

Creates the Make Table View 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 - Table View | Raster Layer, the input table or feature class.

outView - Table View | Raster Layer, the name of the in-memory table view to be created.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is Table View | Raster Layer, the input table or feature class. 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 Table View | Raster Layer, the input table or feature class. This is a required parameter.

Parameters:

inTable - Table View | Raster Layer, the input table or feature class.

getOutView

public Object getOutView()

Returns the Table Name parameter of this tool . This parameter is Table View | Raster Layer, the name of the in-memory table view to be created. This is a required parameter.

Returns:

the Table Name

setOutView

public void setOutView(Object outView)

Sets the Table Name parameter of this tool . This parameter is Table View | Raster Layer, the name of the in-memory table view to be created. This is a required parameter.

Parameters:

outView - Table View | Raster Layer, the name of the in-memory table view to be created.

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

getWorkspace

public Object getWorkspace()

Returns the Output Workspace parameter of this tool . This parameter is Workspace, used to validate the field names. The field names in the table view will be formated according to the workspace type. This is an optional parameter.

Returns:

the Output Workspace

setWorkspace

public void setWorkspace(Object workspace)

Sets the Output Workspace parameter of this tool . This parameter is Workspace, used to validate the field names. The field names in the table view will be formated according to the workspace type. This is an optional parameter.

Parameters:

workspace - Workspace, used to validate the field names. The field names in the table view will be formated according to the workspace type.

getFieldInfo

public Object getFieldInfo()

Returns the Field Info parameter of this tool . This parameter is Field Info, specifies which fields from the input table to rename and make visible in the output table view. This is an optional parameter.

Returns:

the Field Info

setFieldInfo

public void setFieldInfo(Object fieldInfo)

Sets the Field Info parameter of this tool . This parameter is Field Info, specifies which fields from the input table to rename and make visible in the output table view. This is an optional parameter.

Parameters:

fieldInfo - Field Info, specifies which fields from the input table to rename and make visible in the output table view.

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