JDOMPropertyConfiguration (Carbon Java Framework v2.1 Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sape.carbon.core.config.format.jdom
Class JDOMPropertyConfiguration

java.lang.Object
  |
  +--org.sape.carbon.core.config.format.jdom.JDOMPropertyConfiguration

All Implemented Interfaces:: Configuration, PropertyConfiguration

public class JDOMPropertyConfiguration
extends Object
implements PropertyConfiguration

This is an implementation of the string based attribute lookup PropertyConfiguration.

Since:: carbon 1.0
Version:: $Revision: 1.20 $($Author: dvoet $ / $Date: 2003/05/05 21:21:17 $)
Author:: Greg Hinkle, February 2002

Field Summary

private static String COMMA_DELIMITER
          Comma delimiter: ,

private org.jdom.Document document
          The JDOM document that holds the root element.

private PropertyConfiguration extendedConfig
          Holds a reference to the configuration this extends.

private String name
          Name of the configuration.

private static String NAME_DELIMITER
          Name delimiter: space

private Map propertyCache
          cache of text values contained in document keyed by property name

private org.jdom.Element rootElement
          Holds the root element of the JDOM document.

private ConfigurationTypeService typeService
          Holds a reference to the type config service.

private static String WHITE_SPACE_INPUT_DELIMITERS
          Deletermins for whitespace input.

private static String WHITE_SPACE_OUTPUT_DELIMITER
          Whitespace output delimiter.

private boolean writable
          True if this object may be altered, false if it should throw exceptions when attempts are made to alter it.

Constructor Summary

JDOMPropertyConfiguration()
          Creates a new empty configruation that extends nothing.

JDOMPropertyConfiguration(org.jdom.Document document)
          Constructs a JDOMConfigurationProxy for the specified class type.

JDOMPropertyConfiguration(org.jdom.Document document, PropertyConfiguration extendedConfig)
          Constructs a new configruation that extends another configuration.

JDOMPropertyConfiguration(PropertyConfiguration extendedConfig)
          Constructs a new blank configruation that extends another configuration.

Method Summary

private String arrayToDelimitedString(String[] values, String delimiter)
          Serializes an array of Strings into a single String with values delimited by delimiter

Object clone()
           This method makes a deep-copy of the underlying data structure for this configuration

private String[] delimitedStringToArray(String delimitedValues, String delimiters)
          Converts a String with values delimted by delimiters to an array of Strings.

boolean getBooleanProperty(String propertyName)
          Retrieves a configured boolean values

boolean getBooleanProperty(String propertyName, boolean defaultValue)
          Retrieves a configured boolean values

byte getByteProperty(String propertyName)
          Retrieves a configured byte property.

byte getByteProperty(String propertyName, byte defaultValue)
          Retrieves a configured byte property.

Class getClassProperty(String propertyName)
          Retrieves a configured class object

Class getClassProperty(String propertyName, Class defaultValue)
          Retrieves a configured Class values

Class getConfigurationInterface()
          Returns the interface of the configuration.

String getConfigurationName()
          Returns the name of this configuration in the backing store, but may be null if the Configuration has not yet been saved to the backing store.

String[] getCSVProperty(String propertyName)
          Retrieves an array of string values that are retrieved from the configuration document at the supplied key.

org.jdom.Document getDataStructure()
          Gets the document containing the root element.

Date getDateProperty(String propertyName)
          Retrieves a configured class object

Date getDateProperty(String propertyName, Date defaultValue)
          Retrieves a configured Class values

double getDoubleProperty(String propertyName)
          Retrieves a configured double value

double getDoubleProperty(String propertyName, double defaultValue)
          Retrieves a configured double values

float getFloatProperty(String propertyName)
          Retrieves a configured float value.

float getFloatProperty(String propertyName, float defaultValue)
          Retrieves a configured float values

int getIntProperty(String propertyName)
          Retrieves a configured int value

int getIntProperty(String propertyName, int defaultValue)
          Retrieves a configured int values

long getLongProperty(String propertyName)
          Retrieves a configured long property.

long getLongProperty(String propertyName, long defaultValue)
          Retrieves a configured long values

String getProperty(String propertyName)
          Retrieves a string property configuration

private Object getProperty(String propertyName, Object defaultValue, Class type)
          Centralized method for property lookup.

String getProperty(String propertyName, String defaultValue)
          Retrieves a string property configuration or returns the supplied default if none is found.

org.jdom.Element getRootElement()
          Gets the root element of the configuration.

short getShortProperty(String propertyName)
          Retrieves a configured short value

short getShortProperty(String propertyName, short defaultValue)
          Retrieves a configured short values

String[] getWSVProperty(String propertyName)
          Retrieves an array of string values that are retrieved from the configuration document at the supplied key.

boolean isConfigurationWritable()
          Is this configuration document writable or is it read-only.

private void preloadProperyCache(org.jdom.Element parentElement, String parentElementName)
          Loads up the property cache with all the values.

void setBooleanProperty(String propertyName, boolean value)
          Sets the property named by propertyName to the value specified by value as a boolean

void setByteProperty(String propertyName, byte value)
          Sets the property named by propertyName to the value specified by value as a byte

void setClassProperty(String propertyName, Class value)
          Sets the property named by propertyName to the value specified by value as a Class

void setConfigurationName(String name)
          Alters the name of this configuration document

void setConfigurationReadOnly()
          Sets whether this configuration may be altered.

void setCSVProperty(String propertyName, String[] values)
          Sets the property named by propertyName to the value specified by value as a comma separated list of strings

void setDateProperty(String propertyName, Date value)
          Sets the property named by propertyName to the value specified by value as a Class

void setDoubleProperty(String propertyName, double value)
          Sets the property named by propertyName to the value specified by value as a double

void setFloatProperty(String propertyName, float value)
          Sets the property named by propertyName to the value specified by value as a float

void setIntProperty(String propertyName, int value)
          Sets the property named by propertyName to the value specified by value as a int

void setLongProperty(String propertyName, long value)
          Sets the property named by propertyName to the value specified by value as a long

void setProperty(String propertyName, String value)
          Sets the property named by propertyName to the value specified by value as a String

void setShortProperty(String propertyName, short value)
          Sets the property named by propertyName to the value specified by value as a short

void setWSVProperty(String propertyName, String[] values)
          Sets the property named by propertyName to the value specified by value as a white-space separated list of strings

Methods inherited from class java.lang.Object

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

Field Detail

NAME_DELIMITER

private static final String NAME_DELIMITER

Name delimiter: space

See Also:: Constant Field Values

COMMA_DELIMITER

private static final String COMMA_DELIMITER

Comma delimiter: ,

See Also:: Constant Field Values

WHITE_SPACE_OUTPUT_DELIMITER

private static final String WHITE_SPACE_OUTPUT_DELIMITER

Whitespace output delimiter. Space.

See Also:: Constant Field Values

WHITE_SPACE_INPUT_DELIMITERS

private static final String WHITE_SPACE_INPUT_DELIMITERS

Deletermins for whitespace input. Includes space, tab and newlline.

See Also:: Constant Field Values

name

private String name

Name of the configuration.

document

private org.jdom.Document document

The JDOM document that holds the root element.

rootElement

private org.jdom.Element rootElement

Holds the root element of the JDOM document.

extendedConfig

private PropertyConfiguration extendedConfig

Holds a reference to the configuration this extends.

typeService

private ConfigurationTypeService typeService

Holds a reference to the type config service.

propertyCache

private Map propertyCache

cache of text values contained in document keyed by property name

writable

private boolean writable

True if this object may be altered, false if it should throw exceptions when attempts are made to alter it.

Constructor Detail

JDOMPropertyConfiguration

public JDOMPropertyConfiguration(org.jdom.Document document)

Constructs a JDOMConfigurationProxy for the specified class type. This class only supports subclasses of the Configuration object. The supplied document is used as the backing store for this configuration object's data.
Parameters:: document - The JDOM Document object representing a configurations data

JDOMPropertyConfiguration

public JDOMPropertyConfiguration()

Creates a new empty configruation that extends nothing.

JDOMPropertyConfiguration

public JDOMPropertyConfiguration(org.jdom.Document document,
                                 PropertyConfiguration extendedConfig)

Constructs a new configruation that extends another configuration.
Parameters:: document - configuration document; extendedConfig - the configuration being extended.

JDOMPropertyConfiguration

public JDOMPropertyConfiguration(PropertyConfiguration extendedConfig)

Constructs a new blank configruation that extends another configuration.
Parameters:: extendedConfig - the configuration being extended.

Method Detail

getConfigurationInterface

public Class getConfigurationInterface()

Returns the interface of the configuration.

Specified by:: getConfigurationInterface in interface Configuration

Returns:: PropertyConfiguration.class

getDataStructure

public org.jdom.Document getDataStructure()

Gets the document containing the root element.

Specified by:: getDataStructure in interface Configuration

Returns:: the document

getRootElement

public org.jdom.Element getRootElement()

Gets the root element of the configuration.

Specified by:: getRootElement in interface Configuration

Returns:: root element of the configuration

getConfigurationName

public String getConfigurationName()

Description copied from interface: Configuration

Returns the name of this configuration in the backing store, but may be null if the Configuration has not yet been saved to the backing store.

Specified by:: getConfigurationName in interface Configuration

Returns:: the fully-qualified path name of this Configuration in the backing store
See Also:: Configuration.getConfigurationName()

setConfigurationName

public void setConfigurationName(String name)

Description copied from interface: Configuration

Alters the name of this configuration document

Specified by:: setConfigurationName in interface Configuration

Parameters:: name - the new name of this configuration document
See Also:: Configuration.setConfigurationName(java.lang.String)

clone

public Object clone()

Description copied from interface: Configuration

This method makes a deep-copy of the underlying data structure for this configuration

Specified by:: clone in interface Configuration
Overrides:: clone in class Object

Returns:: the newly created copy of configuration
See Also:: Configuration.clone()