com.esri.arcgis.geodatabase
Class ConfigurationKeyword

java.lang.Object
  com.esri.arcgis.geodatabase.ConfigurationKeyword

All Implemented Interfaces:

IConfigurationKeyword, java.io.Serializable

public class ConfigurationKeyword

extends java.lang.Object

implements IConfigurationKeyword

ConfigurationKeyword Object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords can be of two types:

• esriConfigurationKeywordGeneral, which references storage parameters for creating feature classes and tables
• esriConfigurationKeywordNetwork, which references storage parameters for creating geometric networks or network datasets
• esriConfigurationKeywordTopology, which references storage parameters for creating topologies

An enumeration of ConfigurationKeyword objects for an ArcSDE or File geodatabase workspace is returned by the IWorkspaceConfiguration interface.

See Also:

Serialized Form

Constructor Summary

ConfigurationKeyword(java.lang.Object obj)
Construct a ConfigurationKeyword using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IConfigurationKeyword	getAsIConfigurationKeyword() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getComments() Any additional comments about the keyword.
IEnumConfigurationParameter	getConfigurationParameters() Configuration parameters included in this keyword.
java.lang.String	getDescription() The description of the keyword.
int	getKeywordType() The type of the keyword.
java.lang.String	getName() The name of the keyword.
int	hashCode() the hashcode for this object

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationKeyword

public ConfigurationKeyword(java.lang.Object obj)
                     throws java.io.IOException

Construct a ConfigurationKeyword using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ConfigurationKeyword.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ConfigurationKeyword o = (ConfigurationKeyword)obj; // will not work

ConfigurationKeyword o = new ConfigurationKeyword(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server ConfigurationKeyword theConfigurationKeyword = (ConfigurationKeyword) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIConfigurationKeyword

public IConfigurationKeyword getAsIConfigurationKeyword()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getKeywordType

public int getKeywordType()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IConfigurationKeyword

The type of the keyword.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getKeywordType in interface IConfigurationKeyword

Returns:

A com.esri.arcgis.geodatabase.esriConfigurationKeywordType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IConfigurationKeyword

The name of the keyword.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IConfigurationKeyword

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IConfigurationKeyword

The description of the keyword.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords in an ArcSDE or File geodatabase can have descriptions associated with them. A keyword's description is a user-friendly string that describes the configuration keyword.

Specified by:

getDescription in interface IConfigurationKeyword

Returns:

The desc

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getComments

public java.lang.String getComments()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IConfigurationKeyword

Any additional comments about the keyword.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords in an ArcSDE or File geodatabase can have descriptions associated with them. A keyword's description is text that describes what the configuration keyword is used for.

Specified by:

getComments in interface IConfigurationKeyword

Returns:

The comments

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getConfigurationParameters

public IEnumConfigurationParameter getConfigurationParameters()
                                                       throws java.io.IOException,
                                                              AutomationException

Description copied from interface: IConfigurationKeyword

Configuration parameters included in this keyword.

Supported Platforms

Windows, Solaris, Linux

Remarks

Configuration keywords in an ArcSDE or File geodatabase are used to specify storage parameters for feature class, tables and geometric networks. These storage parameters can be accessed through the IConfigurationParameters interface. This method returns a collection of parameters for a configuration keyword.

Specified by:

getConfigurationParameters in interface IConfigurationKeyword

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumConfigurationParameter

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.