org.apache.cocoon.sax.component
Class VariableExpanderTransformer

java.lang.Object
  org.apache.cocoon.pipeline.component.AbstractPipelineComponent
      org.apache.cocoon.sax.AbstractSAXPipelineComponent
          org.apache.cocoon.sax.AbstractSAXProducer
              org.apache.cocoon.sax.AbstractSAXTransformer
                  org.apache.cocoon.sax.component.VariableExpanderTransformer

All Implemented Interfaces:

Consumer, PipelineComponent, Producer, SAXConsumer, SAXPipelineComponent, SAXProducer, ContentHandler, LexicalHandler

public final class VariableExpanderTransformer
extends AbstractSAXTransformer
implements SAXConsumer

A transformer that expands variables in the form of ${} inside the processing document. The idea has been borrowed from Apache Commons Digester, Apache Ant, Apache Maven.

Version:

$Id: VariableExpanderTransformer.html 1343757 2012-05-29 14:45:42Z ilgrosso $

Constructor Summary

VariableExpanderTransformer()

Method Summary

void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localName, String name)
void	loadAll(Map<String,String> variables)
void	loadAll(Properties variables)
void	loadEnvironmentVariables()
void	loadProperties(URL propertiesUrl)
void	loadSystemProperties()
void	loadXmlProperties(URL propertiesUrl)
void	setProperty(String key, String value)
void	startElement(String uri, String localName, String name, Attributes atts)

Methods inherited from class org.apache.cocoon.sax.AbstractSAXTransformer

comment, endCDATA, endDocument, endDTD, endEntity, endPrefixMapping, endSAXRecording, endTextRecording, findPrefixMapping, ignorableWhitespace, processingInstruction, removeRecorder, sendEndPrefixMapping, sendStartPrefixMapping, setDocumentLocator, setRecorder, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startPrefixMapping, startSAXRecording, startTextRecording

Methods inherited from class org.apache.cocoon.sax.AbstractSAXProducer

getSAXConsumer, setConsumer, setSAXConsumer, toString

Methods inherited from class org.apache.cocoon.pipeline.component.AbstractPipelineComponent

finish, setConfiguration, setup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

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

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.pipeline.component.PipelineComponent

finish, setConfiguration, setup

Constructor Detail

VariableExpanderTransformer

public VariableExpanderTransformer()

Method Detail

setProperty

public void setProperty(String key,
                        String value)

loadAll

public void loadAll(Map<String,String> variables)

loadAll

public void loadAll(Properties variables)

loadSystemProperties

public void loadSystemProperties()

loadEnvironmentVariables

public void loadEnvironmentVariables()

loadProperties

public void loadProperties(URL propertiesUrl)
                    throws IOException

Throws:

IOException

loadXmlProperties

public void loadXmlProperties(URL propertiesUrl)
                       throws IOException

Throws:

IOException

startElement

public void startElement(String uri,
                         String localName,
                         String name,
                         Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class AbstractSAXTransformer

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class AbstractSAXTransformer

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localName,
                       String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class AbstractSAXTransformer

Throws:

SAXException