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

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

All Implemented Interfaces:

GPTool

public class AddCodedValueToDomain
extends AbstractGPTool

Adds a value to a domain's coded value list. The Add Coded Value To Domain 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 this tool or the tool.Associate the domain with a feature class using the tool.
• The coded value domain includes both the actual value that is stored in the database (for example, 1 for pavement) and a description of what the code value means (for example, pavement).
• A coded value domain which specifies a valid set of values for an attribute can apply to any type of attribute—text, numeric, date, and so on. For example, a coded value list for a text attribute might include valid pipe material values: CL - cast iron pipe; DL - ductile iron pipe; ACP - asbestos concrete pipe, or a coded value list might include the numeric values representing valid pipe diameters: .75–3/4"; 2–2"; 24–24"; and 30–30".
• 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.

Field Summary

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

vals

Constructor Summary

AddCodedValueToDomain()
Creates the Add Coded Value To Domain tool with defaults.

AddCodedValueToDomain(Object inWorkspace, String domainName, String code, String codeDescription)
Creates the Add Coded Value To Domain tool with the required parameters.

Method Summary

String	getCode() Returns the Code Value parameter of this tool .
String	getCodeDescription() Returns the Code Description parameter of this tool .
String	getDomainName() Returns the Domain Name parameter of this tool .
Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace parameter of this tool (Read only).
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	setCode(String code) Sets the Code Value parameter of this tool .
void	setCodeDescription(String codeDescription) Sets the Code Description parameter of this tool .
void	setDomainName(String domainName) Sets the Domain Name parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace 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

AddCodedValueToDomain

public AddCodedValueToDomain()

Creates the Add Coded Value To Domain tool with defaults.

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

AddCodedValueToDomain

public AddCodedValueToDomain(Object inWorkspace,
                             String domainName,
                             String code,
                             String codeDescription)

Creates the Add Coded Value To Domain 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:

inWorkspace - the geodatabase containing the domain to be updated.

domainName - the name of the attribute domain that will have a value added to its coded value list.

code - the value to be added to the specified domain's coded value list.

codeDescription - a description of what the coded value represents.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the geodatabase containing the domain to be updated. This is a required parameter.

Returns:

the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input Workspace parameter of this tool . This parameter is the geodatabase containing the domain to be updated. This is a required parameter.

Parameters:

inWorkspace - the geodatabase containing the domain to be updated.

getDomainName

public String getDomainName()

Returns the Domain Name parameter of this tool . This parameter is the name of the attribute domain that will have a value added to its coded value list. 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 the attribute domain that will have a value added to its coded value list. This is a required parameter.

Parameters:

domainName - the name of the attribute domain that will have a value added to its coded value list.

getCode

public String getCode()

Returns the Code Value parameter of this tool . This parameter is the value to be added to the specified domain's coded value list. This is a required parameter.

Returns:

the Code Value

setCode

public void setCode(String code)

Sets the Code Value parameter of this tool . This parameter is the value to be added to the specified domain's coded value list. This is a required parameter.

Parameters:

code - the value to be added to the specified domain's coded value list.

getCodeDescription

public String getCodeDescription()

Returns the Code Description parameter of this tool . This parameter is a description of what the coded value represents. This is a required parameter.

Returns:

the Code Description

setCodeDescription

public void setCodeDescription(String codeDescription)

Sets the Code Description parameter of this tool . This parameter is a description of what the coded value represents. This is a required parameter.

Parameters:

codeDescription - a description of what the coded value represents.

getOutWorkspace

public Object getOutWorkspace()

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

Returns:

the Output Workspace

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