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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.DomainToTable
All Implemented Interfaces:
GPTool

public class DomainToTable
extends AbstractGPTool

Creates a table from an attribute domain. The Domain To Table tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DomainToTable()
          Creates the Domain To Table tool with defaults.
DomainToTable(Object inWorkspace, String domainName, Object outTable, String codeField, String descriptionField)
          Creates the Domain To Table tool with the required parameters.
 
Method Summary
 String getCodeField()
          Returns the Code Field parameter of this tool .
 String getConfigurationKeyword()
          Returns the Configuration Keyword parameter of this tool .
 String getDescriptionField()
          Returns the Field 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 getOutTable()
          Returns the Output Table 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 setCodeField(String codeField)
          Sets the Code Field parameter of this tool .
 void setConfigurationKeyword(String configurationKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setDescriptionField(String descriptionField)
          Sets the Field 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 .
 void setOutTable(Object outTable)
          Sets the Output Table 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

DomainToTable

public DomainToTable()
Creates the Domain To Table tool with defaults.

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


DomainToTable

public DomainToTable(Object inWorkspace,
                     String domainName,
                     Object outTable,
                     String codeField,
                     String descriptionField)
Creates the Domain To Table 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 - Workspace, the workspace containing the attribute domain to be converted to a table.
domainName - String, the name of the existing attribute domain.
outTable - Table, the table to be created.
codeField - String, the name of the field in the created table that will store code values.
descriptionField - String, the name of the field in the created table that will store code value descriptions.
Method Detail

getInWorkspace

public Object getInWorkspace()
Returns the Input Workspace parameter of this tool . This parameter is Workspace, the workspace containing the attribute domain to be converted to a table. 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 Workspace, the workspace containing the attribute domain to be converted to a table. This is a required parameter.

Parameters:
inWorkspace - Workspace, the workspace containing the attribute domain to be converted to a table.

getDomainName

public String getDomainName()
Returns the Domain Name parameter of this tool . This parameter is String, the name of the existing attribute domain. 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 String, the name of the existing attribute domain. This is a required parameter.

Parameters:
domainName - String, the name of the existing attribute domain.

getOutTable

public Object getOutTable()
Returns the Output Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Returns:
the Output Table

setOutTable

public void setOutTable(Object outTable)
Sets the Output Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Parameters:
outTable - Table, the table to be created.

getCodeField

public String getCodeField()
Returns the Code Field parameter of this tool . This parameter is String, the name of the field in the created table that will store code values. This is a required parameter.

Returns:
the Code Field

setCodeField

public void setCodeField(String codeField)
Sets the Code Field parameter of this tool . This parameter is String, the name of the field in the created table that will store code values. This is a required parameter.

Parameters:
codeField - String, the name of the field in the created table that will store code values.

getDescriptionField

public String getDescriptionField()
Returns the Field Description parameter of this tool . This parameter is String, the name of the field in the created table that will store code value descriptions. This is a required parameter.

Returns:
the Field Description

setDescriptionField

public void setDescriptionField(String descriptionField)
Sets the Field Description parameter of this tool . This parameter is String, the name of the field in the created table that will store code value descriptions. This is a required parameter.

Parameters:
descriptionField - String, the name of the field in the created table that will store code value descriptions.

getConfigurationKeyword

public String getConfigurationKeyword()
Returns the Configuration Keyword parameter of this tool . This parameter is String, for SDE tables, the custom storage keywords for creating the table. This is an optional parameter.

Returns:
the Configuration Keyword

setConfigurationKeyword

public void setConfigurationKeyword(String configurationKeyword)
Sets the Configuration Keyword parameter of this tool . This parameter is String, for SDE tables, the custom storage keywords for creating the table. This is an optional parameter.

Parameters:
configurationKeyword - String, for SDE tables, the custom storage keywords for creating the 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