org.openehealth.ipf.commons.xml

Class XsltTransmogrifier<T>

java.lang.Object

org.openehealth.ipf.commons.xml.AbstractCachingXmlProcessor<Templates>

org.openehealth.ipf.commons.xml.XsltTransmogrifier<T>

All Implemented Interfaces:

org.openehealth.ipf.commons.core.modules.api.Transmogrifier<Source,T>

Direct Known Subclasses:

SchematronTransmogrifier

public class XsltTransmogrifier<T>
extends AbstractCachingXmlProcessor<Templates>
implements org.openehealth.ipf.commons.core.modules.api.Transmogrifier<Source,T>

Xslt Processor transforming a Source into an object of type T. The stylesheet to be used is passed with the zap(Source, Object...) call, however, the Xslt Template object is cached for subsequent transformations using this stylesheet.

Xslt parameters can be passed in as Map parameter.

Note: This class is thread-safe and reentrant.

Author:

Christian Ohr

Nested Class Summary

Nested classes/interfaces inherited from class org.openehealth.ipf.commons.xml.AbstractCachingXmlProcessor

AbstractCachingXmlProcessor.Loader<S>

Field Summary

Fields inherited from class org.openehealth.ipf.commons.xml.AbstractCachingXmlProcessor

RESOURCE_LOCATION

Constructor Summary

Constructors

Constructor and Description
XsltTransmogrifier()
XsltTransmogrifier(Class<T> outputFormat)
XsltTransmogrifier(Class<T> outputFormat, ClassLoader classLoader)
XsltTransmogrifier(Class<T> outputFormat, ClassLoader classLoader, Map<String,Object> staticParams)
XsltTransmogrifier(Class<T> outputFormat, Map<String,Object> staticParams)

Method Summary

Modifier and Type	Method and Description
protected Templates	createResource(Object... params) Creates a ready-to-use resource (e.g.
protected ConcurrentMap<String,AbstractCachingXmlProcessor.Loader<Templates>>	getCache()
TransformerFactory	getFactory()
Map<String,Object>	getStaticParams()
void	setStaticParams(Map<String,Object> staticParams)
protected void	setXsltParameters(Transformer transformer, Map<String,Object> param) Sets the parameter to the Transformer object
T	zap(Source source, Object... params) Converts a Source into a Result using a XSL processor.

Methods inherited from class org.openehealth.ipf.commons.xml.AbstractCachingXmlProcessor

resource, resourceCacheKey, resourceContent, resourceLocation, resourceParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

XsltTransmogrifier

public XsltTransmogrifier()

XsltTransmogrifier

public XsltTransmogrifier(Class<T> outputFormat)

XsltTransmogrifier

public XsltTransmogrifier(Class<T> outputFormat,
                          ClassLoader classLoader)

XsltTransmogrifier

public XsltTransmogrifier(Class<T> outputFormat,
                          Map<String,Object> staticParams)

XsltTransmogrifier

public XsltTransmogrifier(Class<T> outputFormat,
                          ClassLoader classLoader,
                          Map<String,Object> staticParams)

Parameters:

outputFormat - currently supported: String, Writer, OutputStream

classLoader - class loader for resource retrieval, may be null

staticParams - static Xslt parameters

Method Detail

getFactory

public TransformerFactory getFactory()

getCache

protected ConcurrentMap<String,AbstractCachingXmlProcessor.Loader<Templates>> getCache()

Specified by:

getCache in class AbstractCachingXmlProcessor<Templates>

Returns:

static cache for the configured resource type. Note that the returned Map is not necessarily synchronized.

zap

public T zap(Source source,
             Object... params)

Converts a Source into a Result using a XSL processor.

The XSL stylesheet resource location is mandatory in the first extra parameter. XSL Parameters may be passed as a Map in the second parameter.

Specified by:

zap in interface org.openehealth.ipf.commons.core.modules.api.Transmogrifier<Source,T>

See Also:

Transmogrifier.zap(java.lang.Object, java.lang.Object[])

setXsltParameters

protected void setXsltParameters(Transformer transformer,
                                 Map<String,Object> param)

Sets the parameter to the Transformer object

createResource

protected Templates createResource(Object... params)

Description copied from class: AbstractCachingXmlProcessor

Creates a ready-to-use resource (e.g. an XML Schema instance) for the given key. Insertion into the cache will happen externally, this method's purpose is only to instantiate the resource to be cached.

This method does not need to be re-entrant, but its result MUST be thread-safe.

Specified by:

createResource in class AbstractCachingXmlProcessor<Templates>

Parameters:

params - validator/transmogrifier parameters.

Returns:

resource of the configured type.

getStaticParams

public Map<String,Object> getStaticParams()

setStaticParams

public void setStaticParams(Map<String,Object> staticParams)