org.jlab.coda.emu.support.configurer

Class Configurer

java.lang.Object

org.jlab.coda.emu.support.configurer.Configurer

All Implemented Interfaces:

org.w3c.dom.DOMErrorHandler, org.w3c.dom.ls.LSParserFilter

public class Configurer
extends java.lang.Object
implements org.w3c.dom.DOMErrorHandler, org.w3c.dom.ls.LSParserFilter

This class is a singleton and contains one static reference to a DOM builder and a DOM serializer. It is used to configure the EMU using XML from a file or string.

LSParserFilters provide applications the ability to examine nodes as they are being constructed while parsing. As each node is examined, it may be modified or removed, or the entire parse may be terminated early.

Author:

heyes Created on Sep 12, 2008

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_NAMESPACES Default namespaces support (true).
protected static int	DEFAULT_PARSE_MODE Field DEFAULT_PARSE_MODE
protected static boolean	DEFAULT_SCHEMA_VALIDATION Default Schema validation support (false).
protected static boolean	DEFAULT_VALIDATION Default validation support (false).
protected static int	FILE_PARSE_MODE Field FILE_PARSE_MODE
protected static int	STRING_PARSE_MODE Field STRING_PARSE_MODE

Fields inherited from interface org.w3c.dom.ls.LSParserFilter

FILTER_ACCEPT, FILTER_INTERRUPT, FILTER_REJECT, FILTER_SKIP

Constructor Summary

Constructors

Constructor and Description
Configurer()

Method Summary

Modifier and Type	Method and Description
short	acceptNode(org.w3c.dom.Node enode)
static org.w3c.dom.Node	getNode(org.w3c.dom.Document doc, java.lang.String path) Method to get the Node object associated with a specific path into an XML document.
static java.lang.String	getValue(org.w3c.dom.Document doc, java.lang.String path) Method to get the value of the Node object given by the path argument or null if there is no such object.
int	getWhatToShow()
boolean	handleError(org.w3c.dom.DOMError error) Method to handle errors.
static void	newContainer(org.w3c.dom.Document doc, java.lang.String path, java.lang.String name) Method to add a new container DataNode object to the Node object given by the path argument.
static void	newValue(org.w3c.dom.Document doc, java.lang.String path, java.lang.String name, java.lang.String value) Method to add an attribute (name/value pair) DataNode object to or replace one with the same name associated with the Node object given by the path argument.
static org.w3c.dom.Document	parseFile(java.lang.String configFile) Method to parse a file containing an XML configuration.
static org.w3c.dom.Document	parseString(java.lang.String xmlConfig) Method to parse a string containing an XML configuration.
static void	removeEmptyTextNodes(org.w3c.dom.Element node) Remove any empty text (child) nodes from a DOM node.
static java.lang.String	serialize(org.w3c.dom.Document doc) Method to serialize a DOM XML document into a string.
static void	setLogger(Logger logger)
static void	setValue(org.w3c.dom.Document doc, java.lang.String path, java.lang.String value) Method to set the value of the DataNode object associated with the Node object given by the path argument.
short	startElement(org.w3c.dom.Element elt)
static DataNode	treeToPanel(org.w3c.dom.Node node, int level) Recursive method to, using the given arg as the top of the tree, add all nodes in the tree to a JPanel for display in a GUI.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAMESPACES

protected static final boolean DEFAULT_NAMESPACES

Default namespaces support (true).

See Also:

Constant Field Values

DEFAULT_VALIDATION

protected static final boolean DEFAULT_VALIDATION

Default validation support (false).

See Also:

Constant Field Values

DEFAULT_SCHEMA_VALIDATION

protected static final boolean DEFAULT_SCHEMA_VALIDATION

Default Schema validation support (false).

See Also:

Constant Field Values

DEFAULT_PARSE_MODE

protected static final int DEFAULT_PARSE_MODE

Field DEFAULT_PARSE_MODE

See Also:

Constant Field Values

STRING_PARSE_MODE

protected static final int STRING_PARSE_MODE

Field STRING_PARSE_MODE

See Also:

Constant Field Values

FILE_PARSE_MODE

protected static final int FILE_PARSE_MODE

Field FILE_PARSE_MODE

See Also:

Constant Field Values

Constructor Detail

Configurer

public Configurer()

Method Detail

setLogger

public static void setLogger(Logger logger)

removeEmptyTextNodes

public static void removeEmptyTextNodes(org.w3c.dom.Element node)

Remove any empty text (child) nodes from a DOM node.

Parameters:

node - node from which to remove empty (child) text nodes

parseFile

public static org.w3c.dom.Document parseFile(java.lang.String configFile)
                                      throws DataNotFoundException

Method to parse a file containing an XML configuration. Needs synchronization if more than one Emu in a JVM.

Parameters:

configFile - file containing an XML configuration

Returns:

Document

Throws:

DataNotFoundException - when

parseString

public static org.w3c.dom.Document parseString(java.lang.String xmlConfig)
                                        throws DataNotFoundException

Method to parse a string containing an XML configuration. Needs synchronization if more than one Emu in a JVM.

Parameters:

xmlConfig - string containing an XML configuration

Returns:

Document

Throws:

DataNotFoundException - when

serialize

public static java.lang.String serialize(org.w3c.dom.Document doc)

Method to serialize a DOM XML document into a string.

Parameters:

doc - DOM object to serialize to string

Returns:

String

handleError

public boolean handleError(org.w3c.dom.DOMError error)

Method to handle errors. Only place logger is used. Called when parsing data and error occurs.

Specified by:

handleError in interface org.w3c.dom.DOMErrorHandler

Parameters:

error - error of type DOMError

Returns:

boolean

acceptNode

public short acceptNode(org.w3c.dom.Node enode)

Specified by:

acceptNode in interface org.w3c.dom.ls.LSParserFilter

See Also:

LSParserFilter.acceptNode(Node)

getWhatToShow

public int getWhatToShow()

Specified by:

getWhatToShow in interface org.w3c.dom.ls.LSParserFilter

See Also:

LSParserFilter.getWhatToShow()

startElement

public short startElement(org.w3c.dom.Element elt)

Specified by:

startElement in interface org.w3c.dom.ls.LSParserFilter

See Also:

LSParserFilter.startElement(Element)

getValue

public static java.lang.String getValue(org.w3c.dom.Document doc,
                                        java.lang.String path)
                                 throws DataNotFoundException

Method to get the value of the Node object given by the path argument or null if there is no such object. If the Node is an attribute it's value is returned, else if not an attribute, then it returns it's first child's text (or null if no kids).

Parameters:

doc - DOM XML Document object

path - path into the XML object

Returns:

value of the Node associated with the given path

Throws:

DataNotFoundException - never thrown

setValue

public static void setValue(org.w3c.dom.Document doc,
                            java.lang.String path,
                            java.lang.String value)
                     throws DataNotFoundException

Method to set the value of the DataNode object associated with the Node object given by the path argument. Does nothing if there is no DataNode object at the given path.

Parameters:

doc - DOM XML Document object

path - path into the XML object

value - value to set the DataNode object to

Throws:

DataNotFoundException - when

newValue

public static void newValue(org.w3c.dom.Document doc,
                            java.lang.String path,
                            java.lang.String name,
                            java.lang.String value)
                     throws DataNotFoundException

Method to add an attribute (name/value pair) DataNode object to or replace one with the same name associated with the Node object given by the path argument. Does nothing if there is no Node object at the given path.

Not Used.

Parameters:

doc - DOM XML Document object

path - path into the XML object

name - name of new attribute to add

value - value of the new attribute

Throws:

DataNotFoundException - when

newContainer

public static void newContainer(org.w3c.dom.Document doc,
                                java.lang.String path,
                                java.lang.String name)
                         throws DataNotFoundException

Method to add a new container DataNode object to the Node object given by the path argument. Does nothing if there is no Node object at the given path.

Not Used.

Parameters:

doc - DOM XML Document object

path - path into the XML object

name - name of new container to add

Throws:

DataNotFoundException - when

treeToPanel

public static DataNode treeToPanel(org.w3c.dom.Node node,
                                   int level)

Recursive method to, using the given arg as the top of the tree, add all nodes in the tree to a JPanel for display in a GUI.

(Formerly method named getDataNodes.)

Parameters:

node - Node object to be displayed in a JPanel

level - level of node in XML document tree (0 = top)

Returns:

DataNode object associated with arg

getNode

public static org.w3c.dom.Node getNode(org.w3c.dom.Document doc,
                                       java.lang.String path)
                                throws DataNotFoundException

Method to get the Node object associated with a specific path into an XML document.

Parameters:

doc - DOM XML Document object

path - path into the XML object

Returns:

Node object (or null if none)

Throws:

DataNotFoundException - when