org.settings4j.config

Class DOMConfigurator

java.lang.Object

org.settings4j.config.DOMConfigurator

public class DOMConfigurator
extends Object

Author:

Harald.Brabenetz

Constructor Summary

Constructors

Constructor and Description
DOMConfigurator(Settings4jRepository repository) Configure the given Settings4jRepository with an XMl-configuration (see settings4j.dtd).

Method Summary

Modifier and Type	Method and Description
void	addExpressionAttribute(String key, Object value) Add a ExpressionAttribute like ('ContextPath', 'myApp').
static void	configure(URL url, Settings4jRepository repository) A static version of doConfigure(URL).
void	doConfigure(URL url)
protected Connector	findConnectorByName(Document doc, String connectorName) Used internally to parse connectors by IDREF name.
protected Connector	findConnectorByReference(Element connectorRef) Used internally to parse connectors by IDREF element.
protected ContentResolver	findContentResolverByName(Document doc, String contentResolverName) Used internally to parse contentResolvers by IDREF name.
protected ContentResolver	findContentResolverByReference(Element contentResolverRef) Used internally to parse contentResolvers by IDREF element.
protected ObjectResolver	findObjectResolverByName(Document doc, String objectResolverName) Used internally to parse objectResolvers by IDREF name.
protected ObjectResolver	findObjectResolverByReference(Element objectResolverRef) Used internally to parse objectResolvers by IDREF element.
protected Connector[]	getConnectors(Element connectorsElement) Return all referenced connectors from Child-Nodes CONNECTOR_REF_TAG.
protected void	parse(Element element) Used internally to configure the settings4j framework by parsing a DOM tree of XML elements based on settings4j.dtd.
protected void	parseChildrenOfSettingsElement(Element settingsElement, Settings4jInstance settings) Used internally to parse the children of a settings element.
protected Connector	parseConnector(Element connectorElement) Used internally to parse an connector element.
protected ContentResolver	parseContentResolver(Element contentResolverElement) Used internally to parse an contentResolver element.
protected Filter	parseFilter(Element filterElement) Used internally to parse an Filter element.
protected Map<String,String>	parseMapping(Element mappingElement) Used internally to parse an mapping element.
protected ObjectResolver	parseObjectResolver(Element objectResolverElement) Used internally to parse an objectResolver element.
protected String	subst(String value, Connector... connectors) This function will replace expressions like ${connectors.string['']}.
protected Object	subst(String value, Connector[] connectors, Class<?> clazz) This function will replace expressions like ${connectors.object['']} or simply ${true}.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMConfigurator

public DOMConfigurator(Settings4jRepository repository)

Configure the given Settings4jRepository with an XMl-configuration (see settings4j.dtd).

Parameters:

repository - The Repository to configure.

Method Detail

configure

public static void configure(URL url,
                             Settings4jRepository repository)
                      throws FactoryConfigurationError

A static version of doConfigure(URL).

Parameters:

url - The location of the configuration file.

repository - the Repository to configure.

Throws:

FactoryConfigurationError - if DocumentBuilderFactory.newInstance() throws an exception.

doConfigure

public void doConfigure(URL url)

Parameters:

url - The location of the configuration file.

parse

protected void parse(Element element)

Used internally to configure the settings4j framework by parsing a DOM tree of XML elements based on settings4j.dtd.

Parameters:

element - The XML CONFIGURATION_TAG Element.

parseFilter

protected Filter parseFilter(Element filterElement)

Used internally to parse an Filter element.

Parameters:

filterElement - the XML-Element for Filter.

Returns:

the Filter-Object

parseConnector

protected Connector parseConnector(Element connectorElement)

Used internally to parse an connector element.

Parameters:

connectorElement - The XML Connector Element

Returns:

the Connector Object.

getConnectors

protected Connector[] getConnectors(Element connectorsElement)

Return all referenced connectors from Child-Nodes CONNECTOR_REF_TAG.

Parameters:

connectorsElement - The XML Connectors Element

Returns:

the Connectors Objects as Array.

parseChildrenOfSettingsElement

protected void parseChildrenOfSettingsElement(Element settingsElement,
                                              Settings4jInstance settings)

Used internally to parse the children of a settings element.

Parameters:

settingsElement - The XML Settings Element

settings - _The Settings Object do apply the values.

findConnectorByName

protected Connector findConnectorByName(Document doc,
                                        String connectorName)

Used internally to parse connectors by IDREF name.

Parameters:

doc - The whole XML configuration.

connectorName - The Connector-Name, to search for.

Returns:

the Connector instance.

findConnectorByReference

protected Connector findConnectorByReference(Element connectorRef)

Used internally to parse connectors by IDREF element.

Parameters:

connectorRef - The Element with the REF_ATTR - Attribute.

Returns:

the Connector instance.

parseObjectResolver

protected ObjectResolver parseObjectResolver(Element objectResolverElement)

Used internally to parse an objectResolver element.

Parameters:

objectResolverElement - The XML Object resolver Element.

Returns:

The ObjectResolver instance.

parseMapping

protected Map<String,String> parseMapping(Element mappingElement)

Used internally to parse an mapping element.

Parameters:

mappingElement - The XML Mapping Element.

Returns:

the Map instance (Key = String; Value = String).

parseContentResolver

protected ContentResolver parseContentResolver(Element contentResolverElement)

Used internally to parse an contentResolver element.

Parameters:

contentResolverElement - The ContentResolver Element.

Returns:

the ContentResolver instance.

findContentResolverByName

protected ContentResolver findContentResolverByName(Document doc,
                                                    String contentResolverName)

Used internally to parse contentResolvers by IDREF name.

Parameters:

doc - XML Document of the whole settings4j.xml.

contentResolverName - the contentResolver Name to search for.

Returns:

the ContentResolver instance.

findObjectResolverByName

protected ObjectResolver findObjectResolverByName(Document doc,
                                                  String objectResolverName)

Used internally to parse objectResolvers by IDREF name.

Parameters:

doc - XML Document of the whole settings4j.xml.

objectResolverName - the ObjectResolver Name to search for.

Returns:

the ObjectResolver instance.

findObjectResolverByReference

protected ObjectResolver findObjectResolverByReference(Element objectResolverRef)

Used internally to parse objectResolvers by IDREF element.

Parameters:

objectResolverRef - The Element with the REF_ATTR.

Returns:

the ObjectResolver instance.

findContentResolverByReference

protected ContentResolver findContentResolverByReference(Element contentResolverRef)

Used internally to parse contentResolvers by IDREF element.

Parameters:

contentResolverRef - The Element with the REF_ATTR.

Returns:

the ContentResolver instance.

subst

protected String subst(String value,
                       Connector... connectors)

This function will replace expressions like ${connectors.string['']}.

Parameters:

value - The value or Expression.

connectors - required for validating Expression like ${connectors.string['']}

Returns:

the String-Value of the given value or Expression

subst

protected Object subst(String value,
                       Connector[] connectors,
                       Class<?> clazz)

This function will replace expressions like ${connectors.object['']} or simply ${true}.

Parameters:

value - The value or Expression.

clazz - The expected Class.

connectors - required for validating Expression like ${connectors.string['']}

Returns:

the Object-Value of the given value or Expression.

addExpressionAttribute

public void addExpressionAttribute(String key,
                                   Object value)

Add a ExpressionAttribute like ('ContextPath', 'myApp').

A settings4j.xml Value like value="c:/settings/${contextPath}" will be evaluated as "c:/settings/myApp".

Parameters:

key - The Key as String.

value - The value as Object.