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

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

All Implemented Interfaces:

GPTool

public class CopyRows
extends AbstractGPTool

Writes the rows from an input table, table view, feature class or feature layer to a new table. The Copy Rows tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• If the input rows are from a feature class; or table; , then all rows will be used. If the input rows are from a layer; or table view; which has a selection, only the selected features or rows will be used.
• If the input rows are a feature class, then only the attributes, and not the geometry, will be copied to the output table.
• If the output table already exists, it will be overwritten. To control the overwrite behavior in an application see the Tools/Options/Geoprocessing options, in a script see the OverwriteOutput property on the geoprocessor object. To add or append the rows to an existing table (without overwritting it) use the Append tool instead.
• The output table can be saved in a dBASE, ArcSDE geodatabase; file geodatabase; , or personal geodatabase; format.
• The following environments affect this tool: configKeyword; extent; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

CopyRows()
Creates the Copy Rows tool with defaults.

CopyRows(Object inRows, Object outTable)
Creates the Copy Rows tool with the required parameters.

Method Summary

String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
Object	getInRows() Returns the Input Rows 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.
void	setConfigKeyword(String configKeyword) Sets the Configuration Keyword parameter of this tool .
void	setInRows(Object inRows) Sets the Input Rows parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table 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

CopyRows

public CopyRows()

Creates the Copy Rows tool with defaults.

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

CopyRows

public CopyRows(Object inRows,
                Object outTable)

Creates the Copy Rows 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 - Table View | Raster Layer, the rows from a feature class, layer, table, or table view to be copied.

outTable - Table, the table to which the rows will be written. If this table already exists it may be overwritten based on the Overwrite output setting. To control the overwrite behavior in an application see the Tools/Options/Geoprocessing options, in a script see the OverwriteOutput property on the geoprocessor object.

Method Detail

getInRows

public Object getInRows()

Returns the Input Rows parameter of this tool . This parameter is Table View | Raster Layer, the rows from a feature class, layer, table, or table view to be copied. 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 Table View | Raster Layer, the rows from a feature class, layer, table, or table view to be copied. This is a required parameter.

Parameters:

inRows - Table View | Raster Layer, the rows from a feature class, layer, table, or table view to be copied.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is Table, the table to which the rows will be written. If this table already exists it may be overwritten based on the Overwrite output setting. To control the overwrite behavior in an application see the Tools/Options/Geoprocessing options, in a script see the OverwriteOutput property on the geoprocessor object. 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 Table, the table to which the rows will be written. If this table already exists it may be overwritten based on the Overwrite output setting. To control the overwrite behavior in an application see the Tools/Options/Geoprocessing options, in a script see the OverwriteOutput property on the geoprocessor object. This is a required parameter.

Parameters:

outTable - Table, the table to which the rows will be written. If this table already exists it may be overwritten based on the Overwrite output setting. To control the overwrite behavior in an application see the Tools/Options/Geoprocessing options, in a script see the OverwriteOutput property on the geoprocessor object.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is String, the config keyword specifies the default storage parameters (configuration) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using ArcSDE. 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 String, the config keyword specifies the default storage parameters (configuration) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using ArcSDE. This is an optional parameter.

Parameters:

configKeyword - String, the config keyword specifies the default storage parameters (configuration) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using ArcSDE.

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