com.esri.arcgis.geoprocessing.tools.conversiontools
Class TableToTable

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

public class TableToTable
extends AbstractGPTool

Converts an input table to a dBASE or geodatabase table. The Table to Table tool is contained in the Conversion Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
TableToTable()
          Creates the Table to Table tool with defaults.
TableToTable(Object inRows, Object outPath, String outName)
          Creates the Table to Table tool with the required parameters.
 
Method Summary
 String getConfigKeyword()
          Returns the Configuration Keyword parameter of this tool .
 Object getFieldMapping()
          Returns the Field Map parameter of this tool .
 Object getInRows()
          Returns the Input Rows parameter of this tool .
 String getOutName()
          Returns the Output Table parameter of this tool .
 Object getOutPath()
          Returns the Output Location parameter of this tool .
 Object getOutTable()
          Returns the Output Table parameter of this tool (Read only).
 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 setConfigKeyword(String configKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setFieldMapping(Object fieldMapping)
          Sets the Field Map parameter of this tool .
 void setInRows(Object inRows)
          Sets the Input Rows parameter of this tool .
 void setOutName(String outName)
          Sets the Output Table parameter of this tool .
 void setOutPath(Object outPath)
          Sets the Output Location 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

TableToTable

public TableToTable()
Creates the Table to Table tool with defaults.

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


TableToTable

public TableToTable(Object inRows,
                    Object outPath,
                    String outName)
Creates the Table to Table 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:
inRows - the input table to be converted to a dBASE, personal, file, or SDE geodatabase table. Input Rows can be dBASE, INFO, VPF, OLE DB, personal, file, or SDE geodatabase tables, or table views.
outPath - the destination where the output table will be written. If a folder is specified, a dBASE table will be created. If a geodatabase is specified, a geodatabase table will be created.
outName - the name of the output table.
Method Detail

getInRows

public Object getInRows()
Returns the Input Rows parameter of this tool . This parameter is the input table to be converted to a dBASE, personal, file, or SDE geodatabase table. Input Rows can be dBASE, INFO, VPF, OLE DB, personal, file, or SDE geodatabase tables, or table views. This is a required parameter.

Returns:
the Input Rows

setInRows

public void setInRows(Object inRows)
Sets the Input Rows parameter of this tool . This parameter is the input table to be converted to a dBASE, personal, file, or SDE geodatabase table. Input Rows can be dBASE, INFO, VPF, OLE DB, personal, file, or SDE geodatabase tables, or table views. This is a required parameter.

Parameters:
inRows - the input table to be converted to a dBASE, personal, file, or SDE geodatabase table. Input Rows can be dBASE, INFO, VPF, OLE DB, personal, file, or SDE geodatabase tables, or table views.

getOutPath

public Object getOutPath()
Returns the Output Location parameter of this tool . This parameter is the destination where the output table will be written. If a folder is specified, a dBASE table will be created. If a geodatabase is specified, a geodatabase table will be created. This is a required parameter.

Returns:
the Output Location

setOutPath

public void setOutPath(Object outPath)
Sets the Output Location parameter of this tool . This parameter is the destination where the output table will be written. If a folder is specified, a dBASE table will be created. If a geodatabase is specified, a geodatabase table will be created. This is a required parameter.

Parameters:
outPath - the destination where the output table will be written. If a folder is specified, a dBASE table will be created. If a geodatabase is specified, a geodatabase table will be created.

getOutName

public String getOutName()
Returns the Output Table parameter of this tool . This parameter is the name of the output table. This is a required parameter.

Returns:
the Output Table

setOutName

public void setOutName(String outName)
Sets the Output Table parameter of this tool . This parameter is the name of the output table. This is a required parameter.

Parameters:
outName - the name of the output table.

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.

getFieldMapping

public Object getFieldMapping()
Returns the Field Map parameter of this tool . This is an optional parameter.

Returns:
the Field Map

setFieldMapping

public void setFieldMapping(Object fieldMapping)
Sets the Field Map parameter of this tool . This is an optional parameter.

Parameters:
fieldMapping - null

getConfigKeyword

public String getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . This parameter is specifies the default storage parameters (configurations) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using SDE geodatabase tables. arcSDE configuration keywords are set by the database administrator. This is an optional parameter.

Returns:
the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Configuration Keyword parameter of this tool . This parameter is specifies the default storage parameters (configurations) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using SDE geodatabase tables. arcSDE configuration keywords are set by the database administrator. This is an optional parameter.

Parameters:
configKeyword - specifies the default storage parameters (configurations) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using SDE geodatabase tables. arcSDE configuration keywords are set by the database administrator.

getOutTable

public Object getOutTable()
Returns the Output Table parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Table

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