org.dlese.dpc.schemedit.config

Class AbstractConfigReader

java.lang.Object

org.dlese.dpc.schemedit.config.AbstractConfigReader

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccessManager, CollectionConfigReader, FrameworkConfigReader, SuggestionServiceManager

public class AbstractConfigReader
extends java.lang.Object
implements java.io.Serializable

Abstract class for extracting information from, and writing to, XML config files

Author:

ostwald

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	debug Description of the Field
protected org.dom4j.DocumentFactory	df
protected DocMap	docMap
protected java.lang.String	nameSpaceInfo
protected java.lang.String	rootElementName
protected java.io.File	source
protected static boolean	writeOnDestroy Description of the Field

Constructor Summary

Constructors

Constructor and Description
AbstractConfigReader(java.io.File source) Create a AbstractConfigReader.
AbstractConfigReader(java.lang.String xmlSource)

Method Summary

Modifier and Type	Method and Description
void	destroy() This method is called at the conclusion of processing and may be used for tear-down.
void	flush() Write config document to disk and then force reread of values.
org.dom4j.Document	getDelocalizedDoc() Gets delocalized Document for this reader.
DocMap	getDocMap() Gets the document attribute of the AbstractConfigReader object
org.dom4j.Document	getDocument() Gets the localized Document for this reader.
org.dom4j.Node	getNode(java.lang.String xpath) Gets a single Node satisfying give XPath.
java.util.List	getNodes(java.lang.String xpath) Get all Nodes satisfying the given xpath.
java.lang.String	getNodeText(java.lang.String xpath) return the Text of a Node satisfying the given XPath.
java.io.File	getSource() Gets the source attribute of the AbstractConfigReader object
java.lang.String	getSourcePath() Gets the sourcePath attribute of the AbstractConfigReader object
protected static void	prtln(java.lang.String s) Print a line to standard out.
void	refresh() Write Document to disk and then set docMap to null, forcing a re-read upon next access.
protected void	setNodeText(java.lang.String xpath, java.lang.String value) Sets the nodeText for specified path, creating new node if necessary.
protected void	setSource(java.io.File file) set source file, used when creating new CollectionConfig's by first reading a default config file and then assigning a new source so it will be written to a new config file

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static boolean debug

Description of the Field

writeOnDestroy

protected static boolean writeOnDestroy

Description of the Field

rootElementName

protected java.lang.String rootElementName

nameSpaceInfo

protected java.lang.String nameSpaceInfo

docMap

protected DocMap docMap

source

protected java.io.File source

df

protected org.dom4j.DocumentFactory df

Constructor Detail

AbstractConfigReader

public AbstractConfigReader(java.io.File source)
                     throws java.lang.Exception

Create a AbstractConfigReader.

Parameters:

source - Description of the Parameter

Throws:

java.lang.Exception

AbstractConfigReader

public AbstractConfigReader(java.lang.String xmlSource)
                     throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getSourcePath

public java.lang.String getSourcePath()

Gets the sourcePath attribute of the AbstractConfigReader object

Returns:

The sourcePath value

getDocMap

public DocMap getDocMap()
                 throws java.lang.Exception

Gets the document attribute of the AbstractConfigReader object

Returns:

The document value

Throws:

java.lang.Exception - Description of the Exception

getSource

public java.io.File getSource()

Gets the source attribute of the AbstractConfigReader object

Returns:

The source value

setSource

protected void setSource(java.io.File file)

set source file, used when creating new CollectionConfig's by first reading a default config file and then assigning a new source so it will be written to a new config file

Parameters:

file - The new source value

getDocument

public org.dom4j.Document getDocument()

Gets the localized Document for this reader.

getDelocalizedDoc

public org.dom4j.Document getDelocalizedDoc()
                                     throws java.lang.Exception

Gets delocalized Document for this reader.

Throws:

java.lang.Exception

flush

public void flush()
           throws java.lang.Exception

Write config document to disk and then force reread of values.

Throws:

java.lang.Exception - Description of the Exception

refresh

public void refresh()

Write Document to disk and then set docMap to null, forcing a re-read upon next access.

getNodes

public java.util.List getNodes(java.lang.String xpath)

Get all Nodes satisfying the given xpath.

Parameters:

xpath - an XPath

Returns:

a List of all modes satisfying given XPath, or null

getNode

public org.dom4j.Node getNode(java.lang.String xpath)

Gets a single Node satisfying give XPath. If more than one Node is found, the first is returned (and a msg is printed).

Parameters:

xpath - an XPath

Returns:

a dom4j Node

getNodeText

public java.lang.String getNodeText(java.lang.String xpath)

return the Text of a Node satisfying the given XPath.

Parameters:

xpath - an XPath\

Returns:

Text of Node or empty String if no Node is found

setNodeText

protected void setNodeText(java.lang.String xpath,
                           java.lang.String value)

Sets the nodeText for specified path, creating new node if necessary.

Parameters:

xpath - The new nodeText value

value - The new nodeText value

destroy

public void destroy()

This method is called at the conclusion of processing and may be used for tear-down.

prtln

protected static void prtln(java.lang.String s)

Print a line to standard out.

Parameters:

s - The String to print.