com.databasesandlife.util

Class DomVariableExpander

java.lang.Object

com.databasesandlife.util.IdentityForwardingSaxHandler

com.databasesandlife.util.DomVariableExpander

All Implemented Interfaces:

ContentHandler

public class DomVariableExpander
extends IdentityForwardingSaxHandler

Takes a DOM XML tree which can have variables such as $xyz, and a Map of variable values, and creates a new DOM with those variables expanded.

Usage:

    Map<String, String> variables = ...
    Element elementWithVariables = ...
    Document elementExpanded = DomVariableExpander.expand(
       elementWithVariables, variables);          

Variables may be written in attribute values and in text contents, and may be written in the XML as $xyz or ${xyz}. Variables in the Map passed to the expand method should not have the dollar prefix. Variable names may contain a-z, A-Z, 0-9, hypen and underscore and are case sensitive.

This class is namespace aware.

Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomVariableExpander.VariableNotFoundException

Constructor Summary

Constructors

Constructor and Description
DomVariableExpander(TransformerHandler outputHandler, Map<String,String> variables)

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
static Document	expand(Node prototypeElement, Map<String,String> variables)
void	startElement(String uri, String localName, String el, Attributes templateAttributes)

Methods inherited from class com.databasesandlife.util.IdentityForwardingSaxHandler

endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping

Methods inherited from class java.lang.Object

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

Constructor Detail

DomVariableExpander

public DomVariableExpander(TransformerHandler outputHandler,
                           Map<String,String> variables)

Method Detail

startElement

public void startElement(String uri,
                         String localName,
                         String el,
                         Attributes templateAttributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class IdentityForwardingSaxHandler

Throws:

SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class IdentityForwardingSaxHandler

Throws:

SAXException

expand

public static Document expand(Node prototypeElement,
                              Map<String,String> variables)
                       throws DomVariableExpander.VariableNotFoundException

Throws:

DomVariableExpander.VariableNotFoundException