com.esri.gpt.catalog.schema
Class Component

java.lang.Object
  com.esri.gpt.catalog.schema.Component

Direct Known Subclasses:

Code, Content, ContentValue, Interrogation, Namespace, Parameter, Schema, UiComponent, Validation

public abstract class Component
extends Object

Super-class for a configurable component associated with a metadata schema.

Constructor Summary

Component()
Default constructor.

Component(Component objectToDuplicate)
Construct by duplicating an existing object.

Method Summary

void	configure(CfgContext context, Node node, NamedNodeMap attributes) Configures the object based upon a node loaded from a schema configuration XML.
abstract Component	duplicate() Produces a deep clone of the object.
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
String	getKey() Gets the key.
void	setKey(String key) Sets the key.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Component

public Component()

Default constructor.

Component

public Component(Component objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getKey

public String getKey()

Gets the key.

Returns:

the key

setKey

public void setKey(String key)

Sets the key.
The key will be trimmed.
A null key is treated as an empty string.

Parameters:

key - the key

configure

public void configure(CfgContext context,
                      Node node,
                      NamedNodeMap attributes)

Configures the object based upon a node loaded from a schema configuration XML.
The super.configure method should be invoked prior to any sub-class configuration.

The following attributes are configured:
key

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

duplicate

public abstract Component duplicate()

Produces a deep clone of the object.

The typical approach is to invoke a duplication constructor.
Example: return new Parameter(this);

echo

public void echo(StringBuffer sb)

Appends property information for the component to a StringBuffer.
The method is intended to support "FINEST" logging.
super.echo should be invoked prior appending any local information.

Parameters:

sb - the StringBuffer to use when appending information

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string