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

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

public class AddSubtype
extends AbstractGPTool

Adds a new subtype to the subtypes in the input table. A field in the feature class or table must be assigned as the subtype field before new subtypes can be added. The Add Subtype tool is contained in the Data Management Tools tool box.
Learn more about working with subtypes

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AddSubtype()
          Creates the Add Subtype tool with defaults.
AddSubtype(Object inTable, int subtypeCode, String subtypeDescription)
          Creates the Add Subtype tool with the required parameters.
 
Method Summary
 Object getInTable()
          Returns the Input Table parameter of this tool .
 Object getOutTable()
          Returns the Output Table parameter of this tool (Read only).
 int getSubtypeCode()
          Returns the Subtype Code parameter of this tool .
 String getSubtypeDescription()
          Returns the Subtype Name 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 setInTable(Object inTable)
          Sets the Input Table parameter of this tool .
 void setSubtypeCode(int subtypeCode)
          Sets the Subtype Code parameter of this tool .
 void setSubtypeDescription(String subtypeDescription)
          Sets the Subtype Name 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

AddSubtype

public AddSubtype()
Creates the Add Subtype tool with defaults.

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


AddSubtype

public AddSubtype(Object inTable,
                  int subtypeCode,
                  String subtypeDescription)
Creates the Add Subtype 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, the feature class or table containing the subtype definition to be updated.
subtypeCode - Long, a unique integer value for the subtype to be added.
subtypeDescription - String, a description of the subtype code.
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is Table View, the feature class or table containing the subtype definition to be updated. 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, the feature class or table containing the subtype definition to be updated. This is a required parameter.

Parameters:
inTable - Table View, the feature class or table containing the subtype definition to be updated.

getSubtypeCode

public int getSubtypeCode()
Returns the Subtype Code parameter of this tool . This parameter is Long, a unique integer value for the subtype to be added. This is a required parameter.

Returns:
the Subtype Code

setSubtypeCode

public void setSubtypeCode(int subtypeCode)
Sets the Subtype Code parameter of this tool . This parameter is Long, a unique integer value for the subtype to be added. This is a required parameter.

Parameters:
subtypeCode - Long, a unique integer value for the subtype to be added.

getSubtypeDescription

public String getSubtypeDescription()
Returns the Subtype Name parameter of this tool . This parameter is String, a description of the subtype code. This is a required parameter.

Returns:
the Subtype Name

setSubtypeDescription

public void setSubtypeDescription(String subtypeDescription)
Sets the Subtype Name parameter of this tool . This parameter is String, a description of the subtype code. This is a required parameter.

Parameters:
subtypeDescription - String, a description of the subtype code.

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