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

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

All Implemented Interfaces:

GPTool

public class CreateDomain
extends AbstractGPTool

Creates an attribute domain in the specified workspace. The Create Domain tool is contained in the Data Management Tools tool box.

Usage tips:

• Domain management involves the following steps:Create the domain using the this 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 the tool.
• Coded value domains support only default value and duplicate split policies and default value merge policies.
• Range domains support all split and merge policies. After a Split or Merge operation, the attribute values of output features are calculated based on the numeric values of the input features and the specified split or merge policy.
• 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

CreateDomain()
Creates the Create Domain tool with defaults.

CreateDomain(Object inWorkspace, String domainName, String domainDescription, String fieldType)
Creates the Create Domain tool with the required parameters.

Method Summary

String	getDomainDescription() Returns the Domain Description parameter of this tool .
String	getDomainName() Returns the Domain Name parameter of this tool .
String	getDomainType() Returns the Domain Type parameter of this tool .
String	getFieldType() Returns the Field Type parameter of this tool .
Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
String	getMergePolicy() Returns the Merge Policy parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace parameter of this tool (Read only).
String	getSplitPolicy() Returns the Split Policy 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	setDomainDescription(String domainDescription) Sets the Domain Description parameter of this tool .
void	setDomainName(String domainName) Sets the Domain Name parameter of this tool .
void	setDomainType(String domainType) Sets the Domain Type parameter of this tool .
void	setFieldType(String fieldType) Sets the Field Type parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setMergePolicy(String mergePolicy) Sets the Merge Policy parameter of this tool .
void	setSplitPolicy(String splitPolicy) Sets the Split Policy 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

CreateDomain

public CreateDomain()

Creates the Create Domain tool with defaults.

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

CreateDomain

public CreateDomain(Object inWorkspace,
                    String domainName,
                    String domainDescription,
                    String fieldType)

Creates the Create 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 that will contain the new domain.

domainName - the name of the domain that will be created.

domainDescription - the description of the domain that will be created.

fieldType - the type of attribute domain to create. Attribute domains are rules that describe the legal values of a field type. Specify a field type that matches the data type of the field to which the attribute domain will be assigned.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the geodatabase that will contain the new domain. 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 that will contain the new domain. This is a required parameter.

Parameters:

inWorkspace - the geodatabase that will contain the new domain.

getDomainName

public String getDomainName()

Returns the Domain Name parameter of this tool . This parameter is the name of the domain that will be created. 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 domain that will be created. This is a required parameter.

Parameters:

domainName - the name of the domain that will be created.

getDomainDescription

public String getDomainDescription()

Returns the Domain Description parameter of this tool . This parameter is the description of the domain that will be created. This is a required parameter.

Returns:

the Domain Description

setDomainDescription

public void setDomainDescription(String domainDescription)

Sets the Domain Description parameter of this tool . This parameter is the description of the domain that will be created. This is a required parameter.

Parameters:

domainDescription - the description of the domain that will be created.

getFieldType

public String getFieldType()

Returns the Field Type parameter of this tool . This parameter is the type of attribute domain to create. Attribute domains are rules that describe the legal values of a field type. Specify a field type that matches the data type of the field to which the attribute domain will be assigned. This is a required parameter.

Returns:

the Field Type

setFieldType

public void setFieldType(String fieldType)

Sets the Field Type parameter of this tool . This parameter is the type of attribute domain to create. Attribute domains are rules that describe the legal values of a field type. Specify a field type that matches the data type of the field to which the attribute domain will be assigned. This is a required parameter.

Parameters:

fieldType - the type of attribute domain to create. Attribute domains are rules that describe the legal values of a field type. Specify a field type that matches the data type of the field to which the attribute domain will be assigned.

getDomainType

public String getDomainType()

Returns the Domain Type parameter of this tool . This parameter is the domain type to create: This is an optional parameter.

Returns:

the Domain Type

setDomainType

public void setDomainType(String domainType)

Sets the Domain Type parameter of this tool . This parameter is the domain type to create: This is an optional parameter.

Parameters:

domainType - the domain type to create:

getSplitPolicy

public String getSplitPolicy()

Returns the Split Policy parameter of this tool . This parameter is the split policy of the created domain. The behavior of an attribute's values when a feature that is split is controlled by its split policy. This is an optional parameter.

Returns:

the Split Policy

setSplitPolicy

public void setSplitPolicy(String splitPolicy)

Sets the Split Policy parameter of this tool . This parameter is the split policy of the created domain. The behavior of an attribute's values when a feature that is split is controlled by its split policy. This is an optional parameter.

Parameters:

splitPolicy - the split policy of the created domain. The behavior of an attribute's values when a feature that is split is controlled by its split policy.

getMergePolicy

public String getMergePolicy()

Returns the Merge Policy parameter of this tool . This parameter is the merge policy of the created domain. When two features are merged into a single feature, merge policies control attribute values in the new feature. This is an optional parameter.

Returns:

the Merge Policy

setMergePolicy

public void setMergePolicy(String mergePolicy)

Sets the Merge Policy parameter of this tool . This parameter is the merge policy of the created domain. When two features are merged into a single feature, merge policies control attribute values in the new feature. This is an optional parameter.

Parameters:

mergePolicy - the merge policy of the created domain. When two features are merged into a single feature, merge policies control attribute values in the new feature.

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