com.esri.arcgis.geodatabase
Class ConfigurationKeyword

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

All Implemented Interfaces:

IConfigurationKeyword, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ConfigurationKeyword
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IConfigurationKeyword

ConfigurationKeyword Object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
String	getComments() Any additional comments about the keyword.
IEnumConfigurationParameter	getConfigurationParameters() Configuration parameters included in this keyword.
String	getDescription() The description of the keyword.
int	getKeywordType() The type of the keyword.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ConfigurationKeyword

public ConfigurationKeyword(Object obj)
                     throws 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

Throws:

IOException - if there are interop problems ConfigurationKeyword theConfigurationKeyword = (ConfigurationKeyword) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getKeywordType

public int getKeywordType()
                   throws IOException,
                          AutomationException

The type of the keyword.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getKeywordType in interface IConfigurationKeyword

Returns:

A com.esri.arcgis.geodatabase.esriConfigurationKeywordType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the keyword.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IConfigurationKeyword

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the keyword.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IConfigurationKeyword

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getComments

public String getComments()
                   throws IOException,
                          AutomationException

Any additional comments about the keyword.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getComments in interface IConfigurationKeyword

Returns:

The comments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationParameters

public IEnumConfigurationParameter getConfigurationParameters()
                                                       throws IOException,
                                                              AutomationException

Configuration parameters included in this keyword.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConfigurationParameters in interface IConfigurationKeyword

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.