org.apache.commons.configuration

Class HierarchicalConfigurationXMLReader

public class HierarchicalConfigurationXMLReader extends ConfigurationXMLReader

A specialized SAX2 XML parser that "parses" hierarchical configuration objects.

This class mimics to be a SAX conform XML parser. Instead of parsing XML documents it processes a Configuration object and generates SAX events for the single properties defined there. This enables the whole world of XML processing for configuration objects.

The HierarchicalConfiguration object to be parsed can be specified using a constructor or the setConfiguration() method. This object will be processed by the parse() methods. Note that these methods ignore their argument.

Version: $Id: HierarchicalConfigurationXMLReader.java 439648 2006-09-02 20:42:10Z oheger $

Author: Oliver Heger

Nested Class Summary
classHierarchicalConfigurationXMLReader.SAXVisitor
A specialized visitor class for generating SAX events for a hierarchical node structure.
Field Summary
HierarchicalConfigurationconfiguration
Stores the configuration object to be parsed.
Constructor Summary
HierarchicalConfigurationXMLReader()
Creates a new instance of HierarchicalConfigurationXMLReader.
HierarchicalConfigurationXMLReader(HierarchicalConfiguration config)
Creates a new instance of HierarchicalConfigurationXMLReader and sets the configuration to be parsed.
Method Summary
HierarchicalConfigurationgetConfiguration()
Returns the configuration object to be parsed.
ConfigurationgetParsedConfiguration()
Returns the configuration object to be processed.
protected voidprocessKeys()
Processes the actual configuration object to generate SAX parsing events.
voidsetConfiguration(HierarchicalConfiguration config)
Sets the configuration object to be parsed.

Field Detail

configuration

private HierarchicalConfiguration configuration
Stores the configuration object to be parsed.

Constructor Detail

HierarchicalConfigurationXMLReader

public HierarchicalConfigurationXMLReader()
Creates a new instance of HierarchicalConfigurationXMLReader.

HierarchicalConfigurationXMLReader

public HierarchicalConfigurationXMLReader(HierarchicalConfiguration config)
Creates a new instance of HierarchicalConfigurationXMLReader and sets the configuration to be parsed.

Parameters: config the configuration object

Method Detail

getConfiguration

public HierarchicalConfiguration getConfiguration()
Returns the configuration object to be parsed.

Returns: the configuration object to be parsed

getParsedConfiguration

public Configuration getParsedConfiguration()
Returns the configuration object to be processed.

Returns: the actual configuration object

processKeys

protected void processKeys()
Processes the actual configuration object to generate SAX parsing events.

setConfiguration

public void setConfiguration(HierarchicalConfiguration config)
Sets the configuration object to be parsed.

Parameters: config the configuration object to be parsed