| java.lang.Object
 org.apache.commons.configuration.HierarchicalConfigurationConverter
| HierarchicalConfigurationConverter | | abstract class HierarchicalConfigurationConverter (Code) | | A base class for converters that transform a normal configuration
object into a hierarchical configuration.
This class provides a default mechanism for iterating over the keys in a
configuration and to throw corresponding element start and end events. By
handling these events a hierarchy can be constructed that is equivalent to
the keys in the original configuration.
Concrete sub classes will implement event handlers that generate SAX
events for XML processing or construct a
HierarchicalConfiguration root node. All in all with this class
it is possible to treat a default configuration as if it was a hierarchical
configuration, which can be sometimes useful.
See Also: HierarchicalConfiguration
author:
Oliver Heger
version:
$Id: HierarchicalConfigurationConverter.java 439648 2006-09-02 20:42:10Z oheger $ |
| closeElements | | protected void closeElements(ConfigurationKey keyLast, ConfigurationKey keyAct)(Code) | | Fires all necessary element end events for the specified keys. This
method is called for each key obtained from the configuration to be
converted. It calculates the common part of the actual and the last
processed key and thus determines how many elements must be
closed.
Parameters:
keyLast - the last processed key
Parameters:
keyAct - the actual key |
| elementEnd | | abstract protected void elementEnd(String name)(Code) | | An event handler method that is called when an element ends. For each
call of elementStart() there will be a corresponding call
of this method. Concrete sub classes must implement it to perform a
proper event handling.
Parameters:
name - the name of the ending element |
| elementStart | | abstract protected void elementStart(String name, Object value)(Code) | | An event handler method that is called when an element starts.
Concrete sub classes must implement it to perform a proper event
handling.
Parameters:
name - the name of the new element
Parameters:
value - the element's value; can be null if the elementdoes not have any value |
| fireValue | | protected void fireValue(String name, Object value)(Code) | | Fires all necessary element start events with the actual element values.
This method is called for each key obtained from the configuration to be
processed with the last part of the key as argument. The value can be
either a single value or a collection.
Parameters:
name - the name of the actual element
Parameters:
value - the element's value |
| openElements | | protected String openElements(ConfigurationKey keyLast, ConfigurationKey keyAct, Configuration config, Set keySet)(Code) | | Fires all necessary element start events for the specified key. This
method is called for each key obtained from the configuration to be
converted. It ensures that all elements "between" the last key and the
actual key are opened and their values are set.
Parameters:
keyLast - the last processed key
Parameters:
keyAct - the actual key
Parameters:
config - the configuration to process
Parameters:
keySet - the set with the processed keys the name of the last element on the path |
| process | | public void process(Configuration config)(Code) | | Processes the specified configuration object. This method implements
the iteration over the configuration's keys. All defined keys are
translated into a set of element start and end events represented by
calls to the elementStart() and
elementEnd() methods.
Parameters:
config - the configuration to be processed |
| reverseIterator | | protected Iterator reverseIterator(ConfigurationKey key)(Code) | | Helper method for determining a reverse iterator for the specified key.
This implementation returns an iterator that returns the parts of the
given key in reverse order, ignoring indices.
Parameters:
key - the key a reverse iterator for the parts of this key |
|
|