Package org.mycore.common.content.transformer

Class MCRXSLTransformer

java.lang.Object

org.mycore.common.content.transformer.MCRContentTransformer

org.mycore.common.content.transformer.MCRParameterizedTransformer

org.mycore.common.content.transformer.MCRXSLTransformer

Direct Known Subclasses:

MCRXSL2JAXBTransformer, MCRXSL2XMLTransformer

public class MCRXSLTransformer
extends MCRParameterizedTransformer

Transforms XML content using a static XSL stylesheet. The stylesheet is configured via MCR.ContentTransformer.{ID}.Stylesheet. You may choose your own instance of SAXTransformerFactory via MCR.ContentTransformer.{ID}.TransformerFactoryClass. The default transformer factory implementation TransformerFactoryImpl is configured with MCR.LayoutService.TransformerFactoryClass.

Author:

Frank Lützenkirchen

Field Summary

Fields

Modifier and Type	Field	Description
protected long[]	modified
protected long	modifiedChecked
protected Templates[]	templates
protected MCRTemplatesSource[]	templateSources	The compiled XSL stylesheet
protected SAXTransformerFactory	tFactory

Fields inherited from class org.mycore.common.content.transformer.MCRContentTransformer

contentDisposition, DEFAULT_CONTENT_DISPOSITION, fileExtension, mimeType

Constructor Summary

Constructors

Constructor	Description
MCRXSLTransformer()
MCRXSLTransformer(Class<? extends TransformerFactory> tfClass)
MCRXSLTransformer(String... stylesheets)

Method Summary

Modifier and Type	Method	Description
String	getEncoding()	Returns the encoding of characters in the binary stream.
String	getFileExtension()	Returns the file extension that is usually related to the transformed content.
static MCRXSLTransformer	getInstance(Class<? extends TransformerFactory> tfClass, String... stylesheets)
static MCRXSLTransformer	getInstance(String... stylesheets)
String	getMimeType()	Returns the MIME type of the transformed content, may return the default mime type
Properties	getOutputProperties()
protected MCRContent	getTransformedContent(MCRContent source, XMLReader reader, TransformerHandler transformerHandler)
protected LinkedList<TransformerHandler>	getTransformHandlerList(MCRParameterCollector parameterCollector)
protected XMLReader	getXMLReader(LinkedList<TransformerHandler> transformHandlerList)
void	init(String id)	Called by the factory to initialize configuration of this transformer
void	setStylesheets(String... stylesheets)
void	setTransformerFactory(String factoryClass)
MCRContent	transform(MCRContent source)	Transforms MCRContent.
void	transform(MCRContent source, OutputStream out)
void	transform(MCRContent source, OutputStream out, MCRParameterCollector parameter)
MCRContent	transform(MCRContent source, MCRParameterCollector parameter)	Transforms MCRContent.
protected MCRContent	transform(MCRContent source, XMLReader reader, TransformerHandler transformerHandler, MCRParameterCollector parameter)

Methods inherited from class org.mycore.common.content.transformer.MCRContentTransformer

getContentDisposition, getDefaultExtension, getDefaultMimeType

Methods inherited from class java.lang.Object

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

Field Details

templateSources

protected MCRTemplatesSource[] templateSources

The compiled XSL stylesheet

templates

protected Templates[] templates

modified

protected long[] modified

modifiedChecked

protected long modifiedChecked

tFactory

protected SAXTransformerFactory tFactory

Constructor Details

MCRXSLTransformer

public MCRXSLTransformer(String... stylesheets)

MCRXSLTransformer

public MCRXSLTransformer()

MCRXSLTransformer

public MCRXSLTransformer(Class<? extends TransformerFactory> tfClass)

Method Details

setTransformerFactory

public void setTransformerFactory(String factoryClass)
                           throws TransformerFactoryConfigurationError

Throws:

TransformerFactoryConfigurationError

getInstance

public static MCRXSLTransformer getInstance(String... stylesheets)

getInstance

public static MCRXSLTransformer getInstance(Class<? extends TransformerFactory> tfClass,
 String... stylesheets)

init

public void init(String id)

Description copied from class: MCRContentTransformer

Called by the factory to initialize configuration of this transformer

Overrides:

init in class MCRContentTransformer

setStylesheets

public void setStylesheets(String... stylesheets)

getEncoding

public String getEncoding()
                   throws TransformerException,
SAXException,
ParserConfigurationException

Description copied from class: MCRContentTransformer

Returns the encoding of characters in the binary stream. Will return null if the encoding is unknown or the results does not represent character data.

Overrides:

getEncoding in class MCRContentTransformer

Throws:

TransformerException

SAXException

ParserConfigurationException

getMimeType

public String getMimeType()
                   throws TransformerException,
SAXException,
ParserConfigurationException

Description copied from class: MCRContentTransformer

Returns the MIME type of the transformed content, may return the default mime type

Overrides:

getMimeType in class MCRContentTransformer

Throws:

TransformerException

SAXException

ParserConfigurationException

transform

public MCRContent transform(MCRContent source)
                     throws IOException

Description copied from class: MCRContentTransformer

Transforms MCRContent. Subclasses implement different transformation methods

Specified by:

transform in class MCRContentTransformer

Throws:

IOException

transform

public MCRContent transform(MCRContent source,
 MCRParameterCollector parameter)
                     throws IOException

Description copied from class: MCRParameterizedTransformer

Transforms MCRContent. Subclasses implement different transformation methods

Specified by:

transform in class MCRParameterizedTransformer

Throws:

IOException

transform

public void transform(MCRContent source,
 OutputStream out)
               throws IOException

Overrides:

transform in class MCRContentTransformer

Throws:

IOException

transform

public void transform(MCRContent source,
 OutputStream out,
 MCRParameterCollector parameter)
               throws IOException

Overrides:

transform in class MCRParameterizedTransformer

Throws:

IOException

transform

protected MCRContent transform(MCRContent source,
 XMLReader reader,
 TransformerHandler transformerHandler,
 MCRParameterCollector parameter)
                        throws IOException,
SAXException,
TransformerException,
ParserConfigurationException

Throws:

IOException

SAXException

TransformerException

ParserConfigurationException

getTransformedContent

protected MCRContent getTransformedContent(MCRContent source,
 XMLReader reader,
 TransformerHandler transformerHandler)
                                    throws IOException,
SAXException

Throws:

IOException

SAXException

getTransformHandlerList

protected LinkedList<TransformerHandler> getTransformHandlerList(MCRParameterCollector parameterCollector)
                                                          throws TransformerConfigurationException,
SAXException,
ParserConfigurationException

Throws:

TransformerConfigurationException

SAXException

ParserConfigurationException

getXMLReader

protected XMLReader getXMLReader(LinkedList<TransformerHandler> transformHandlerList)
                          throws SAXException,
ParserConfigurationException

Throws:

SAXException

ParserConfigurationException

getOutputProperties

public Properties getOutputProperties()
                               throws TransformerConfigurationException,
SAXException,
ParserConfigurationException

Throws:

TransformerConfigurationException

SAXException

ParserConfigurationException

getFileExtension

public String getFileExtension()
                        throws TransformerException,
SAXException,
ParserConfigurationException

Description copied from class: MCRContentTransformer

Returns the file extension that is usually related to the transformed content.

Overrides:

getFileExtension in class MCRContentTransformer

Throws:

TransformerException

SAXException

ParserConfigurationException