org.jboss.windup.rules.apps.xml.operation.xslt

Class XSLTTransformation

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.jboss.windup.config.operation.GraphOperation

org.jboss.windup.config.operation.iteration.AbstractIterationOperation<XmlFileModel>

org.jboss.windup.rules.apps.xml.operation.xslt.XSLTTransformation

All Implemented Interfaces:

XSLTTransformationDescription, XSLTTransformationEffort, XSLTTransformationExtension, XSLTTransformationFileSystem, XSLTTransformationLocation, XSLTTransformationOf, org.ocpsoft.rewrite.config.Operation, org.ocpsoft.rewrite.config.OperationBuilder

public class XSLTTransformation
extends AbstractIterationOperation<XmlFileModel>
implements XSLTTransformationDescription, XSLTTransformationExtension, XSLTTransformationLocation, XSLTTransformationFileSystem, XSLTTransformationOf

Graph operation doing the xslt transformation using the .xslt source on the target xml object

Author:

Matej Briskar

Method Summary

Modifier and Type	Method and Description
void	addXsltParameter(String key, String value)
String	getDescription()
String	getExtension()
String	getTemplate()
Map<String,String>	getXsltParameters()
boolean	isUseSaxon() Indicates whether this is configured to use saxon
static XSLTTransformationOf	of(String variable) Create a new transformation for the given ref.
void	perform(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context) Set the payload to the fileModel of the given instance even though the variable is not directly of it's type.
void	perform(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, XmlFileModel payload)
void	setContextClassLoader(ClassLoader classLoader)
XSLTTransformation	setUseSaxon(boolean useSaxon) Switch to Saxon, instead of the builtin Java parser (Xalan).
static XSLTTransformationLocation	using(String location) Create a new XSLTTransformation using the given location of the source XSLT file within the current Thread.getContextClassLoader().
static XSLTTransformationLocation	using(String location, ClassLoader classLoader) Create a new XSLTTransformation using the given location of the source XSLT file within the given ClassLoader.
static XSLTTransformationFileSystem	usingFilesystem(String location) Create a new XSLTTransformation using the given location of the source XSLT file path on the file-system.
XSLTTransformationLocation	usingTemplate(String template) Set the location of the XSLT template to be used.
XSLTTransformationLocation	usingTemplate(String location, ClassLoader loader) Set the location of the XSLT template to be used, and the ClassLoader within which the template is contained.
XSLTTransformationDescription	withDescription(String description) Description of the XSLTTransformation operation
XSLTTransformation	withEffort(int effort) Set the estimated effort associated with this XSLTTransformation;
XSLTTransformationExtension	withExtension(String extension) Extension to be appended to the result file.
XSLTTransformationEffort	withParameters(Map<String,String> parameters) Set the parameters associated with this XSLTTransformation;

Methods inherited from class org.jboss.windup.config.operation.iteration.AbstractIterationOperation

camelCase, checkVariableName, getVariableName, hasVariableNameSet, resolvePayload, resolveVariable, setVariableName, toString

Methods inherited from class org.jboss.windup.config.operation.GraphOperation

perform

Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

and

Methods inherited from class java.lang.Object

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

Method Detail

of

public static XSLTTransformationOf of(String variable)

Create a new transformation for the given ref.

using

public static XSLTTransformationLocation using(String location)

Create a new XSLTTransformation using the given location of the source XSLT file within the current Thread.getContextClassLoader().

usingFilesystem

public static XSLTTransformationFileSystem usingFilesystem(String location)

Create a new XSLTTransformation using the given location of the source XSLT file path on the file-system.

using

public static XSLTTransformationLocation using(String location,
                                               ClassLoader classLoader)

Create a new XSLTTransformation using the given location of the source XSLT file within the given ClassLoader.

perform

public void perform(GraphRewrite event,
                    org.ocpsoft.rewrite.context.EvaluationContext context)

Set the payload to the fileModel of the given instance even though the variable is not directly of it's type. This is mainly to simplify the creation of the rule, when the FileModel itself is not being iterated but just a model referencing it.

Overrides:

perform in class AbstractIterationOperation<XmlFileModel>

isUseSaxon

public boolean isUseSaxon()

Indicates whether this is configured to use saxon

setUseSaxon

public XSLTTransformation setUseSaxon(boolean useSaxon)

Switch to Saxon, instead of the builtin Java parser (Xalan).

addXsltParameter

public void addXsltParameter(String key,
                             String value)

withDescription

public XSLTTransformationDescription withDescription(String description)

Description copied from interface: XSLTTransformationLocation

Description of the XSLTTransformation operation

Specified by:

withDescription in interface XSLTTransformationFileSystem

Specified by:

withDescription in interface XSLTTransformationLocation

usingTemplate

public XSLTTransformationLocation usingTemplate(String template)

Description copied from interface: XSLTTransformationOf

Set the location of the XSLT template to be used.

Specified by:

usingTemplate in interface XSLTTransformationOf

usingTemplate

public XSLTTransformationLocation usingTemplate(String location,
                                                ClassLoader loader)

Description copied from interface: XSLTTransformationOf

Set the location of the XSLT template to be used, and the ClassLoader within which the template is contained.

Specified by:

usingTemplate in interface XSLTTransformationOf

withExtension

public XSLTTransformationExtension withExtension(String extension)

Description copied from interface: XSLTTransformationDescription

Extension to be appended to the result file.

Specified by:

withExtension in interface XSLTTransformationDescription

perform

public void perform(GraphRewrite event,
                    org.ocpsoft.rewrite.context.EvaluationContext context,
                    XmlFileModel payload)

Specified by:

perform in class AbstractIterationOperation<XmlFileModel>

withParameters

public XSLTTransformationEffort withParameters(Map<String,String> parameters)

Set the parameters associated with this XSLTTransformation;

Specified by:

withParameters in interface XSLTTransformationExtension

withEffort

public XSLTTransformation withEffort(int effort)

Set the estimated effort associated with this XSLTTransformation;

Specified by:

withEffort in interface XSLTTransformationEffort

setContextClassLoader

public void setContextClassLoader(ClassLoader classLoader)

getDescription

public String getDescription()

getTemplate

public String getTemplate()

getExtension

public String getExtension()

getXsltParameters

public Map<String,String> getXsltParameters()