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

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

All Implemented Interfaces:

GPTool

public class AssignDefaultToField
extends AbstractGPTool

This tool will create a default value for a specified field. Whenever a new row is added to the table or feature class, the specified field will be set to this default value. The Assign Default To Field tool is contained in the Data Management Tools tool box.

Usage tips:

• The default value is dependent on the field type chosen in the Field Name parameter. If you pick a field that is type LONG, the default value has to be type LONG.
• Adding subtypes to the default value is optional. If you add a subtype, there must be a subtype field in the feature class or table. You can set the subtype field using the tool.
• The subtypes of a feature class or table can also be managed in the Catalog window. Subtypes can be created and modified using the Subtypes Property page on the dataset Properties dialog box.

Field Summary

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

vals

Constructor Summary

AssignDefaultToField()
Creates the Assign Default To Field tool with defaults.

AssignDefaultToField(Object inTable, Object fieldName, String defaultValue)
Creates the Assign Default To Field tool with the required parameters.

Method Summary

String	getDefaultValue() Returns the Default Value parameter of this tool .
Object	getFieldName() 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).
Object	getSubtypeCode() Returns the Subtype 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	setDefaultValue(String defaultValue) Sets the Default Value parameter of this tool .
void	setFieldName(Object fieldName) Sets the Field Name parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setSubtypeCode(Object subtypeCode) Sets the Subtype 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

AssignDefaultToField

public AssignDefaultToField()

Creates the Assign Default To Field tool with defaults.

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

AssignDefaultToField

public AssignDefaultToField(Object inTable,
                            Object fieldName,
                            String defaultValue)

Creates the Assign Default To 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 - input table or feature class that will have a default value added to one of its fields.

fieldName - field that will have the default value added to it each time a new row is added to the table or feature class.

defaultValue - the string for the default value to be added to each new table or feature class. The field type controls what kind of string can be added.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is input table or feature class that will have a default value added to one of its fields. 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 input table or feature class that will have a default value added to one of its fields. This is a required parameter.

Parameters:

inTable - input table or feature class that will have a default value added to one of its fields.

getFieldName

public Object getFieldName()

Returns the Field Name parameter of this tool . This parameter is field that will have the default value added to it each time a new row is added to the table or feature class. This is a required parameter.

Returns:

the Field Name

setFieldName

public void setFieldName(Object fieldName)

Sets the Field Name parameter of this tool . This parameter is field that will have the default value added to it each time a new row is added to the table or feature class. This is a required parameter.

Parameters:

fieldName - field that will have the default value added to it each time a new row is added to the table or feature class.

getDefaultValue

public String getDefaultValue()

Returns the Default Value parameter of this tool . This parameter is the string for the default value to be added to each new table or feature class. The field type controls what kind of string can be added. This is a required parameter.

Returns:

the Default Value

setDefaultValue

public void setDefaultValue(String defaultValue)

Sets the Default Value parameter of this tool . This parameter is the string for the default value to be added to each new table or feature class. The field type controls what kind of string can be added. This is a required parameter.

Parameters:

defaultValue - the string for the default value to be added to each new table or feature class. The field type controls what kind of string can be added.

getSubtypeCode

public Object getSubtypeCode()

Returns the Subtype parameter of this tool . This parameter is the subtypes that can participate in the default value. You specify the subtypes to be used. This is an optional parameter.

Returns:

the Subtype

setSubtypeCode

public void setSubtypeCode(Object subtypeCode)

Sets the Subtype parameter of this tool . This parameter is the subtypes that can participate in the default value. You specify the subtypes to be used. This is an optional parameter.

Parameters:

subtypeCode - the subtypes that can participate in the default value. You specify the subtypes to be used.

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