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

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

public class SetSubtypeField
extends AbstractGPTool

Defines the field in the input table or feature class that stores the subtype codes. The Set Subtype Field 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
SetSubtypeField()
          Creates the Set Subtype Field tool with defaults.
SetSubtypeField(Object inTable, Object field)
          Creates the Set Subtype Field tool with the required parameters.
 
Method Summary
 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 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.
 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

SetSubtypeField

public SetSubtypeField()
Creates the Set Subtype Field tool with defaults.

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


SetSubtypeField

public SetSubtypeField(Object inTable,
                       Object field)
Creates the Set Subtype 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 - the input table or feature class which contains the field to set as a subtype field.
field - an integer field that will store the subtype codes.
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is the input table or feature class which contains the field to set as a subtype field. 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 the input table or feature class which contains the field to set as a subtype field. This is a required parameter.

Parameters:
inTable - the input table or feature class which contains the field to set as a subtype field.

getField

public Object getField()
Returns the Field Name parameter of this tool . This parameter is an integer field that will store the subtype codes. 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 an integer field that will store the subtype codes. This is a required parameter.

Parameters:
field - an integer field that will store the subtype codes.

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