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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.SetDefaultSubtype

All Implemented Interfaces:

GPTool

public class SetDefaultSubtype
extends AbstractGPTool

Sets the default value or code for the input table's subtype. The Set Default Subtype tool is contained in the Data Management Tools tool box.

Usage tips:

• The input table must contain subtype codes before setting a default code. Use the and tools to create subtype codes.
• The subtype of a feature class or table can also be managed in ArcCatalog. Subtypes can be created and modified using the Subtype Property page on the dataset's Properties dialog box.

Field Summary

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

vals

Constructor Summary

SetDefaultSubtype()
Creates the Set Default Subtype tool with defaults.

SetDefaultSubtype(Object inTable, int subtypeCode)
Creates the Set Default 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	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 .

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

SetDefaultSubtype

public SetDefaultSubtype()

Creates the Set Default Subtype tool with defaults.

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

SetDefaultSubtype

public SetDefaultSubtype(Object inTable,
                         int subtypeCode)

Creates the Set Default 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 - the input table or feature class whose subtype default value will be set.

subtypeCode - the unique default value for a subtype.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the input table or feature class whose subtype default value will be set. 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 whose subtype default value will be set. This is a required parameter.

Parameters:

inTable - the input table or feature class whose subtype default value will be set.

getSubtypeCode

public int getSubtypeCode()

Returns the Subtype Code parameter of this tool . This parameter is the unique default value for a subtype. 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 the unique default value for a subtype. This is a required parameter.

Parameters:

subtypeCode - the unique default value for a subtype.

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