org.openehealth.ipf.commons.xml

Class XqjTransmogrifier<T>

java.lang.Object

org.openehealth.ipf.commons.xml.AbstractCachingXmlProcessor<javax.xml.xquery.XQPreparedExpression>

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

Type Parameters:

T - output type

All Implemented Interfaces:

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

public class XqjTransmogrifier<T>
extends AbstractCachingXmlProcessor<javax.xml.xquery.XQPreparedExpression>
implements org.openehealth.ipf.commons.core.modules.api.Transmogrifier<Source,T>

XQuery transformer similar to the XsltTransmogrifier

Author:

Stefan Ivanov

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
XqjTransmogrifier()
XqjTransmogrifier(Class<T> outputFormat)
XqjTransmogrifier(Class<T> outputFormat, ClassLoader classLoader)
XqjTransmogrifier(Class<T> outputFormat, ClassLoader classLoader, Map<String,Object> globalParams)
XqjTransmogrifier(Class<T> outputFormat, Map<String,Object> globalParams)

Method Summary

Modifier and Type	Method and Description
javax.xml.xquery.XQPreparedExpression	createResource(Object... params) Creates a ready-to-use resource (e.g.
protected ConcurrentMap<String,AbstractCachingXmlProcessor.Loader<javax.xml.xquery.XQPreparedExpression>>	getCache()
Map<String,Object>	getStaticParams()
protected javax.xml.xquery.XQPreparedExpression	resource(Object... params) This method had to be overridden because XQPreparedExpression objects are not thread-safe, thus an additional replication step is necessary.
void	setStaticParams(Map<String,Object> staticParams)
T	zap(Source source, Object... params) Converts a Source into a typed result using a XQuery processor.

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

resourceCacheKey, resourceContent, resourceLocation, resourceParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

XqjTransmogrifier

public XqjTransmogrifier()

XqjTransmogrifier

public XqjTransmogrifier(Class<T> outputFormat)

Parameters:

outputFormat - currently supported: String, Writer, OutputStream

XqjTransmogrifier

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

Parameters:

outputFormat - currently supported: String, Writer, OutputStream

classLoader - class loader for resource retrieval, may be null

XqjTransmogrifier

public XqjTransmogrifier(Class<T> outputFormat,
                         Map<String,Object> globalParams)

Parameters:

outputFormat - currently supported: String, Writer, OutputStream

globalParams - static XQuery parameters

XqjTransmogrifier

public XqjTransmogrifier(Class<T> outputFormat,
                         ClassLoader classLoader,
                         Map<String,Object> globalParams)

Parameters:

outputFormat - currently supported: String, Writer, OutputStream

classLoader - class loader for resource retrieval, may be null

globalParams - static XQuery parameters

Method Detail

getCache

protected ConcurrentMap<String,AbstractCachingXmlProcessor.Loader<javax.xml.xquery.XQPreparedExpression>> getCache()

Specified by:

getCache in class AbstractCachingXmlProcessor<javax.xml.xquery.XQPreparedExpression>

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 typed result using a XQuery processor.

The XQ resource location is mandatory in the first extra parameter. Other 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[])

resource

protected javax.xml.xquery.XQPreparedExpression resource(Object... params)
                                                  throws Exception

This method had to be overridden because XQPreparedExpression objects are not thread-safe, thus an additional replication step is necessary.

Overrides:

resource in class AbstractCachingXmlProcessor<javax.xml.xquery.XQPreparedExpression>

Parameters:

params - validator/transmogrifier parameters.

Returns:

resource instance.

Throws:

Exception

createResource

public javax.xml.xquery.XQPreparedExpression 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<javax.xml.xquery.XQPreparedExpression>

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)