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

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

public class CalculateField
extends AbstractGPTool

Calculates the values of a field for a The Calculate Field tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculateField()
          Creates the Calculate Field tool with defaults.
CalculateField(Object inTable, Object field, Object expression)
          Creates the Calculate Field tool with the required parameters.
 
Method Summary
 String getCodeBlock()
          Returns the Code Block parameter of this tool .
 Object getExpression()
          Returns the Expression parameter of this tool .
 String getExpressionType()
          Returns the Expression Type parameter of this tool .
 Object getField()
          Returns the Field Name parameter of this tool .
 Object getInTable()
          Returns the Input Table parameter of this tool .
 Object getOutTable()
          Returns the Output Feature Class 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.
 void setCodeBlock(String codeBlock)
          Sets the Code Block parameter of this tool .
 void setExpression(Object expression)
          Sets the Expression parameter of this tool .
 void setExpressionType(String expressionType)
          Sets the Expression Type parameter of this tool .
 void setField(Object field)
          Sets the Field Name parameter of this tool .
 void setInTable(Object inTable)
          Sets the Input 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

CalculateField

public CalculateField()
Creates the Calculate Field tool with defaults.

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


CalculateField

public CalculateField(Object inTable,
                      Object field,
                      Object expression)
Creates the Calculate Field 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 table that contains the rows from a specified field that will be calculated. The updated values will be added to this table.
field - Field, the field that will be updated with the new calculation.
expression - SQL Expression, the simple calculation expression used to create a value that will populate the selected rows.
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is Table View | Raster Layer, the table that contains the rows from a specified field that will be calculated. The updated values will be added to this 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 Table View | Raster Layer, the table that contains the rows from a specified field that will be calculated. The updated values will be added to this table. This is a required parameter.

Parameters:
inTable - Table View | Raster Layer, the table that contains the rows from a specified field that will be calculated. The updated values will be added to this table.

getField

public Object getField()
Returns the Field Name parameter of this tool . This parameter is Field, the field that will be updated with the new calculation. This is a required parameter.

Returns:
the Field Name

setField

public void setField(Object field)
Sets the Field Name parameter of this tool . This parameter is Field, the field that will be updated with the new calculation. This is a required parameter.

Parameters:
field - Field, the field that will be updated with the new calculation.

getExpression

public Object getExpression()
Returns the Expression parameter of this tool . This parameter is SQL Expression, the simple calculation expression used to create a value that will populate the selected rows. This is a required parameter.

Returns:
the Expression

setExpression

public void setExpression(Object expression)
Sets the Expression parameter of this tool . This parameter is SQL Expression, the simple calculation expression used to create a value that will populate the selected rows. This is a required parameter.

Parameters:
expression - SQL Expression, the simple calculation expression used to create a value that will populate the selected rows.

getExpressionType

public String getExpressionType()
Returns the Expression Type parameter of this tool . This parameter is String, for a comparison of 9.2 and 9.3 geoprocessor, see This is an optional parameter.

Returns:
the Expression Type

setExpressionType

public void setExpressionType(String expressionType)
Sets the Expression Type parameter of this tool . This parameter is String, for a comparison of 9.2 and 9.3 geoprocessor, see This is an optional parameter.

Parameters:
expressionType - String, for a comparison of 9.2 and 9.3 geoprocessor, see

getCodeBlock

public String getCodeBlock()
Returns the Code Block parameter of this tool . This parameter is String, allows for a block of code to be entered for complex expressions. This is an optional parameter.

Returns:
the Code Block

setCodeBlock

public void setCodeBlock(String codeBlock)
Sets the Code Block parameter of this tool . This parameter is String, allows for a block of code to be entered for complex expressions. This is an optional parameter.

Parameters:
codeBlock - String, allows for a block of code to be entered for complex expressions.

getOutTable

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

Returns:
the Output Feature Class

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