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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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. If a selection is defined on a feature class or feature layer in ArcMap, only the selected rows are copied out. The Copy Rows 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
CopyRows()
          Creates the Copy Rows tool with defaults.
CopyRows(java.lang.Object inRows, java.lang.Object outTable)
          Creates the Copy Rows tool with the required parameters.
 
Method Summary
 java.lang.String getConfigKeyword()
          Returns the Configuration Keyword parameter of this tool .
 java.lang.Object getInRows()
          Returns the Input Rows parameter of this tool .
 java.lang.Object getOutTable()
          Returns the Output Table parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setConfigKeyword(java.lang.String configKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setInRows(java.lang.Object inRows)
          Sets the Input Rows parameter of this tool .
 void setOutTable(java.lang.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(java.lang.Object inRows,
                java.lang.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 - the rows from a feature class, layer, table, or table view to be copied.
outTable - the table to which the rows will be written. If the output table already exists and the Geoprocessing Option: 'Overwrite the outputs of geoprocessing operations' is checked, it will be overwritten. To prevent overwriting from the tool dialog box, uncheck that option. the table to which the rows will be written. If the output table already exists, it will be overwritten. To prevent overwriting in a script, set the OverwriteOutput property on the geoprocessor object to false or 0.
Method Detail

getInRows

public java.lang.Object getInRows()
Returns the Input Rows parameter of this tool . This parameter is 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(java.lang.Object inRows)
Sets the Input Rows parameter of this tool . This parameter is the rows from a feature class, layer, table, or table view to be copied. This is a required parameter.

Parameters:
inRows - the rows from a feature class, layer, table, or table view to be copied.

getOutTable

public java.lang.Object getOutTable()
Returns the Output Table parameter of this tool . This parameter is the table to which the rows will be written. If the output table already exists and the Geoprocessing Option: 'Overwrite the outputs of geoprocessing operations' is checked, it will be overwritten. To prevent overwriting from the tool dialog box, uncheck that option. the table to which the rows will be written. If the output table already exists, it will be overwritten. To prevent overwriting in a script, set the OverwriteOutput property on the geoprocessor object to false or 0. This is a required parameter.

Returns:
the Output Table

setOutTable

public void setOutTable(java.lang.Object outTable)
Sets the Output Table parameter of this tool . This parameter is the table to which the rows will be written. If the output table already exists and the Geoprocessing Option: 'Overwrite the outputs of geoprocessing operations' is checked, it will be overwritten. To prevent overwriting from the tool dialog box, uncheck that option. the table to which the rows will be written. If the output table already exists, it will be overwritten. To prevent overwriting in a script, set the OverwriteOutput property on the geoprocessor object to false or 0. This is a required parameter.

Parameters:
outTable - the table to which the rows will be written. If the output table already exists and the Geoprocessing Option: 'Overwrite the outputs of geoprocessing operations' is checked, it will be overwritten. To prevent overwriting from the tool dialog box, uncheck that option. the table to which the rows will be written. If the output table already exists, it will be overwritten. To prevent overwriting in a script, set the OverwriteOutput property on the geoprocessor object to false or 0.

getConfigKeyword

public java.lang.String getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . This parameter is the config keyword specifies the default storage parameters for an ArcSDE geodatabase. This is an optional parameter.

Returns:
the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(java.lang.String configKeyword)
Sets the Configuration Keyword parameter of this tool . This parameter is the config keyword specifies the default storage parameters for an ArcSDE geodatabase. This is an optional parameter.

Parameters:
configKeyword - the config keyword specifies the default storage parameters for an ArcSDE geodatabase.

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias