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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• A field in the feature class or table must be assigned as the subtype field before new subtypes can be added. This is done using the Set Subtype Field Set Subtype Field; tool.
• If you add a subtype whose code already exists, the new subtype will be ignored.
• If you need to change the description of an existing subtype, you would first have to remove the subtype; , then add a new subtype with the same code and a new description.
• The subtypes of a feature class or table can also be managed in ArcCatalog. Subtypes can be created and modified using the Subtypes Property page on the dataset's Properties dialog box.
• The environment settings do not have an effect on this tool.

Field Summary

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

vals

Constructor Summary

AddSubtype()
Creates the Add Subtype tool with defaults.

AddSubtype(java.lang.Object inTable, int subtypeCode, java.lang.String subtypeDescription)
Creates the Add Subtype tool with the required parameters.

Method Summary

java.lang.Object	getInTable() Returns the Input Table parameter of this tool .
java.lang.Object	getOutTable() Returns the Output Table parameter of this tool (Read only).
int	getSubtypeCode() Returns the Subtype Code parameter of this tool .
java.lang.String	getSubtypeDescription() Returns the Subtype Name 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	setInTable(java.lang.Object inTable) Sets the Input Table parameter of this tool .
void	setSubtypeCode(int subtypeCode) Sets the Subtype Code parameter of this tool .
void	setSubtypeDescription(java.lang.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(java.lang.Object inTable,
                  int subtypeCode,
                  java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.Object getOutTable()

Returns the Output Table parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Table

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