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

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

All Implemented Interfaces:

GPTool

public class TableToDomain
extends AbstractGPTool

Creates or updates a coded value domain with values from a table. The Table To Domain tool is contained in the Data Management Tools tool box.

Usage tips:

• A domain can also be created with the tool.
• 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

TableToDomain()
Creates the Table To Domain tool with defaults.

TableToDomain(Object inTable, Object codeField, Object descriptionField, Object inWorkspace, String domainName)
Creates the Table To Domain tool with the required parameters.

Method Summary

Object	getCodeField() Returns the Code Field parameter of this tool .
Object	getDescriptionField() Returns the Description Field parameter of this tool .
String	getDomainDescription() Returns the Domain Description parameter of this tool .
String	getDomainName() Returns the Domain Name parameter of this tool .
Object	getInTable() Returns the Input Table 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.
String	getUpdateOption() Returns the Update Option parameter of this tool .
void	setCodeField(Object codeField) Sets the Code Field parameter of this tool .
void	setDescriptionField(Object descriptionField) Sets the Description Field parameter 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	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setUpdateOption(String updateOption) Sets the Update Option 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

TableToDomain

public TableToDomain()

Creates the Table To Domain tool with defaults.

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

TableToDomain

public TableToDomain(Object inTable,
                     Object codeField,
                     Object descriptionField,
                     Object inWorkspace,
                     String domainName)

Creates the Table 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:

inTable - the database table from which to derive domain values.

codeField - the field in the database table from which to derive domain code values.

descriptionField - the field in the database table from which to derive domain description values.

inWorkspace - the workspace that contains the domain to be created or updated.

domainName - the name of the domain to be created or updated.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the database table from which to derive domain values. 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 database table from which to derive domain values. This is a required parameter.

Parameters:

inTable - the database table from which to derive domain values.

getCodeField

public Object getCodeField()

Returns the Code Field parameter of this tool . This parameter is the field in the database table from which to derive domain code values. This is a required parameter.

Returns:

the Code Field

setCodeField

public void setCodeField(Object codeField)

Sets the Code Field parameter of this tool . This parameter is the field in the database table from which to derive domain code values. This is a required parameter.

Parameters:

codeField - the field in the database table from which to derive domain code values.

getDescriptionField

public Object getDescriptionField()

Returns the Description Field parameter of this tool . This parameter is the field in the database table from which to derive domain description values. This is a required parameter.

Returns:

the Description Field

setDescriptionField

public void setDescriptionField(Object descriptionField)

Sets the Description Field parameter of this tool . This parameter is the field in the database table from which to derive domain description values. This is a required parameter.

Parameters:

descriptionField - the field in the database table from which to derive domain description values.

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the workspace that contains the domain to be created or 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 workspace that contains the domain to be created or updated. This is a required parameter.

Parameters:

inWorkspace - the workspace that contains the domain to be created or updated.

getDomainName

public String getDomainName()

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

Parameters:

domainName - the name of the domain to be created or updated.

getDomainDescription

public String getDomainDescription()

Returns the Domain Description parameter of this tool . This parameter is the description of the domain to be created or updated. Domain descriptions of existing domains are not updated. This is an optional 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 to be created or updated. Domain descriptions of existing domains are not updated. This is an optional parameter.

Parameters:

domainDescription - the description of the domain to be created or updated. Domain descriptions of existing domains are not updated.

getUpdateOption

public String getUpdateOption()

Returns the Update Option parameter of this tool . This parameter is if the domain already exists, specifies how the domain will be updated. This is an optional parameter.

Returns:

the Update Option

setUpdateOption

public void setUpdateOption(String updateOption)

Sets the Update Option parameter of this tool . This parameter is if the domain already exists, specifies how the domain will be updated. This is an optional parameter.

Parameters:

updateOption - if the domain already exists, specifies how the domain will be updated.

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