Esri Geoportal Server
1.0

com.esri.gpt.catalog.schema
Class Code

java.lang.Object
  extended by com.esri.gpt.catalog.schema.Component
      extended by com.esri.gpt.catalog.schema.Code

public class Code
extends Component

Code component associated with a parameter's content.

The component is configured from a node with a schema configuration XML document.

Example:
<code key="documentDigital" resourceKey="catalog.mdCode.presentationForm.documentDigital"/>


Constructor Summary
Code()
          Default constructor.
Code(Code 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.
 Code duplicate()
          Produces a deep clone of the object.
 void echo(StringBuffer sb)
          Appends property information for the component to a StringBuffer.
 String getResourceKey()
          Gets the UI property bundle resource key.
 void setResourceKey(String key)
          Sets the UI property bundle resource key.
 
Methods inherited from class com.esri.gpt.catalog.schema.Component
getKey, setKey, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Code

public Code()
Default constructor.


Code

public Code(Code objectToDuplicate)
Construct by duplicating an existing object.

Parameters:
objectToDuplicate - the object to duplicate
Method Detail

getResourceKey

public String getResourceKey()
Gets the UI property bundle resource key.

Returns:
the resource key

setResourceKey

public void setResourceKey(String key)
Sets the UI property bundle resource key.
The key will be trimmed.
A null key is treated as an empty string.

Parameters:
key - the resource 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 resourceKey

Overrides:
configure in class Component
Parameters:
context - the configuration context
node - the configuration node
attributes - the attributes of the configuration node

duplicate

public Code duplicate()
Produces a deep clone of the object.
The duplication constructor is invoked.
return new Code(this);

Specified by:
duplicate in class Component

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.

Overrides:
echo in class Component
Parameters:
sb - the StringBuffer to use when appending information

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.