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

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

All Implemented Interfaces:

GPTool

public class AssignDomainToField
extends AbstractGPTool

Sets the domain for a particular field and, optionally, for a subtype. If no subtype is specified, the domain is only assigned to the specified field. The Assign Domain To Field tool is contained in the Data Management Tools tool box.

Usage tips:

• Domain management involves the following steps:Create the domain using the tool.Add values to or set the range of values for the domain using the tool or tool.Associate the domain with a feature class using this tool.
• When an attribute domain is associated with a table or feature class, an attribute validation rule is created in the database. This attribute validation rule describes and constrains the valid values of a field type.
• One attribute domain can be associated with multiple fields in the same table, feature class, or subtype as well as in multiple tables and feature classes.
• Feature layers or table views may be used to define the Input Table.
• Workspace domains can also be managed in ArcCatalog or the Catalog window. Domains can be created and modified through the Domains tab on the Database Properties dialog box.
• The Subtype parameter Add Value button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or its derived data does not exist, the Subtype parameter may not be populated with values. The Add Value button allows you to add expected values so you can complete the Assign Domain To Field dialog and continue to build your model.

Field Summary

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

vals

Constructor Summary

AssignDomainToField()
Creates the Assign Domain To Field tool with defaults.

AssignDomainToField(Object inTable, Object fieldName, String domainName)
Creates the Assign Domain To Field tool with the required parameters.

Method Summary

String	getDomainName() Returns the Domain Name 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	setDomainName(String domainName) Sets the Domain Name 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

AssignDomainToField

public AssignDomainToField()

Creates the Assign Domain To Field tool with defaults.

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

AssignDomainToField

public AssignDomainToField(Object inTable,
                           Object fieldName,
                           String domainName)

Creates the Assign Domain 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 - the name of the table or feature class containing the field that will be assigned a domain.

fieldName - the name of the field to be assigned a domain.

domainName - the name of a geodatabase domain to assign to the field name. Available domains will automatically be loaded.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the name of the table or feature class containing the field that will be assigned a domain. 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 name of the table or feature class containing the field that will be assigned a domain. This is a required parameter.

Parameters:

inTable - the name of the table or feature class containing the field that will be assigned a domain.

getFieldName

public Object getFieldName()

Returns the Field Name parameter of this tool . This parameter is the name of the field to be assigned a domain. 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 the name of the field to be assigned a domain. This is a required parameter.

Parameters:

fieldName - the name of the field to be assigned a domain.

getDomainName

public String getDomainName()

Returns the Domain Name parameter of this tool . This parameter is the name of a geodatabase domain to assign to the field name. Available domains will automatically be loaded. This is a required parameter.

Returns:

the Domain Name

setDomainName

public void setDomainName(String domainName)

Sets the Domain Name parameter of this tool . This parameter is the name of a geodatabase domain to assign to the field name. Available domains will automatically be loaded. This is a required parameter.

Parameters:

domainName - the name of a geodatabase domain to assign to the field name. Available domains will automatically be loaded.

getSubtypeCode

public Object getSubtypeCode()

Returns the Subtype parameter of this tool . This parameter is the subtype code to be assigned a domain. 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 subtype code to be assigned a domain. This is an optional parameter.

Parameters:

subtypeCode - the subtype code to be assigned a domain.

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