de.hawhamburg.reachability.conf.resource

Class SimpleXMLConfigFile

java.lang.Object

de.hawhamburg.reachability.conf.resource.SimpleXMLConfigFile

public class SimpleXMLConfigFile
extends java.lang.Object

Simple access to common configuration variable encoded as XML configuration file.

This class represents a common XML configuration file. It simplifies the access to the XML encoded configuration variables.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private org.w3c.dom.Document	localXMLSource The local XML source as Document.
private java.lang.String	varElementName The common tag name of an configuration element.
private java.lang.String	varKeyAttributeName The common attribute name of an configuration variable.
private java.lang.String	xmlFilePath The path which refers to the XML configuration file.
private java.lang.String	xSettings The common xPath to the settings.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SimpleXMLConfigFile(java.lang.String path) Creates a new SimpleXMLConfigFile object and initially loads the Document from file.
protected	SimpleXMLConfigFile(java.lang.String path, java.lang.String settingsX, java.lang.String elementX, java.lang.String attributeX) Creates a new SimpleXMLConfigFile object, with dissent standard access structure, and initially loads the Document from file.

Method Summary

Methods

Modifier and Type	Method and Description
private void	checkLoad() Loads the local XML source, if it's null, by using refresh().
java.lang.String	get(java.lang.String config) Fetches the value of a certain configuration variable from the XML document.
java.lang.Boolean	getBoolean(java.lang.String config) Fetches the value of a certain configuration variable as Boolean from the XML document.
java.lang.Double	getDouble(java.lang.String config) Fetches the value of a certain configuration variable as Double from the XML document.
java.lang.Integer	getInteger(java.lang.String config) Fetches the value of a certain configuration variable as Integer from the XML document.
java.lang.Long	getLong(java.lang.String config) Fetches the value of a certain configuration variable as Long from the XML document.
void	refresh() Loads the local XML source from file using XMLUtil.loadDocument(String).

Methods inherited from class java.lang.Object

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

Field Detail

xSettings

private java.lang.String xSettings

The common xPath to the settings.

varElementName

private java.lang.String varElementName

The common tag name of an configuration element.

varKeyAttributeName

private java.lang.String varKeyAttributeName

The common attribute name of an configuration variable.

xmlFilePath

private java.lang.String xmlFilePath

The path which refers to the XML configuration file.

localXMLSource

private org.w3c.dom.Document localXMLSource

The local XML source as Document.

Constructor Detail

SimpleXMLConfigFile

public SimpleXMLConfigFile(java.lang.String path)

Creates a new SimpleXMLConfigFile object and initially loads the Document from file.

Parameters:

path - The path which refers to the XML configuration file.

SimpleXMLConfigFile

protected SimpleXMLConfigFile(java.lang.String path,
                   java.lang.String settingsX,
                   java.lang.String elementX,
                   java.lang.String attributeX)

Creates a new SimpleXMLConfigFile object, with dissent standard access structure, and initially loads the Document from file.

Parameters:

path - The path which refers to the XML configuration file.

settingsX - The xPath to the settings.

elementX - The tag name of a configuration element.

attributeX - The name of the attibute which contains the name of the configuration variable.

Method Detail

get

public final java.lang.String get(java.lang.String config)

Fetches the value of a certain configuration variable from the XML document.

Parameters:

config - The name of the configuration variable as String.

Returns:

The value of the element if found as String.

getInteger

public final java.lang.Integer getInteger(java.lang.String config)

Fetches the value of a certain configuration variable as Integer from the XML document.

Parameters:

config - The name of the configuration variable as String.

Returns:

The value of the element if found as Integer.

getDouble

public final java.lang.Double getDouble(java.lang.String config)

Fetches the value of a certain configuration variable as Double from the XML document.

Parameters:

config - The name of the configuration variable as String.

Returns:

The value of the element if found as Double.

getLong

public final java.lang.Long getLong(java.lang.String config)

Fetches the value of a certain configuration variable as Long from the XML document.

Parameters:

config - The name of the configuration variable as String.

Returns:

The value of the element if found as Long.

getBoolean

public final java.lang.Boolean getBoolean(java.lang.String config)

Fetches the value of a certain configuration variable as Boolean from the XML document.

Parameters:

config - The name of the configuration variable as String.

Returns:

The value of the element if found as Boolean.

checkLoad

private void checkLoad()

Loads the local XML source, if it's null, by using refresh().

refresh

public final void refresh()

Loads the local XML source from file using XMLUtil.loadDocument(String).