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 XML element (containing text and sub-nodes), and expands variables like ${xyz}.

Usage:

 try {
     Map<String, String> variables = new Map<>() {{ put("foo", "value"); }};

     // for example <element attr="${foo}">${foo}</element>
     Element elementWithVariables = ...

     Document elementExpanded = DomVariableExpander.expand(
       variableStyle, variables, elementWithVariables);
 }
 catch (VariableNotFoundException e) { .. }
 

For the syntax of variables, see the DomVariableExpander.VariableSyntax enum.

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 XML 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
static class	DomVariableExpander.VariableSyntax

Field Summary

Fields

Modifier and Type	Field and Description
protected DomVariableExpander.VariableSyntax	syntax
protected Map<String,String>	variables

Fields inherited from class com.databasesandlife.util.IdentityForwardingSaxHandler

destinationHandler

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
static Document	expand(DomVariableExpander.VariableSyntax syntax, Map<String,String> variables, Node prototypeElement)
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

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

Field Detail

syntax

protected final DomVariableExpander.VariableSyntax syntax

variables

protected final Map<String,String> variables

Constructor Detail

DomVariableExpander

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

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(DomVariableExpander.VariableSyntax syntax,
                              Map<String,String> variables,
                              Node prototypeElement)
                       throws DomVariableExpander.VariableNotFoundException

Throws:

DomVariableExpander.VariableNotFoundException