org.restlet.ext.xml

Class Transformer

java.lang.Object

org.restlet.Restlet

org.restlet.routing.Filter

org.restlet.ext.xml.Transformer

All Implemented Interfaces:

Uniform

public class Transformer
extends Filter

Filter that can transform XML representations by applying an XSLT transform sheet. It uses the TransformRepresentation to actually transform the XML entities.

Concurrency note: instances of this class or its subclasses can be invoked by several threads at the same time and therefore must be thread-safe. You should be especially careful when storing state in member variables.

Author:

Jerome Louvel

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_REQUEST Mode that transforms request entities before their handling by the attached Restlet.
static int	MODE_RESPONSE Mode that transforms response entities after their handling by the attached Restlet.

Fields inherited from class org.restlet.routing.Filter

CONTINUE, SKIP, STOP

Constructor Summary

Constructors

Constructor and Description
Transformer(int mode, Representation transformSheet) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	afterHandle(Request request, Response response)
protected int	beforeHandle(Request request, Response response)
protected boolean	canTransform(Representation representation) Indicates if the filter can transform the given message entity.
int	getMode() Returns the transformation mode.
CharacterSet	getResultCharacterSet() Returns the character set of the result representation.
java.util.List<Encoding>	getResultEncodings() Returns the modifiable list of encodings of the result representation.
java.util.List<Language>	getResultLanguages() Returns the modifiable list of languages of the result representation.
MediaType	getResultMediaType() Returns the media type of the result representation.
Representation	getTransformSheet() Returns the XSLT transform sheet to apply to message entities.
void	setMode(int mode) Sets the transformation mode.
void	setResultCharacterSet(CharacterSet resultCharacterSet) Sets the character set of the result representation.
void	setResultEncodings(java.util.List<Encoding> resultEncodings) Sets the encodings of the result representation.
void	setResultLanguages(java.util.List<Language> resultLanguages) Sets the languages of the result representation.
void	setResultMediaType(MediaType resultMediaType) Sets the media type of the result representation.
void	setTransformSheet(Representation transformSheet) Sets the XSLT transform sheet to apply to message entities.
Representation	transform(Representation source) Transforms a source XML representation by applying an XSLT transform sheet to it.

Methods inherited from class org.restlet.routing.Filter

doHandle, getNext, handle, hasNext, setNext, setNext, start, stop

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner

Methods inherited from class java.lang.Object

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

Field Detail

MODE_REQUEST

public static final int MODE_REQUEST

Mode that transforms request entities before their handling by the attached Restlet.

See Also:

Constant Field Values

MODE_RESPONSE

public static final int MODE_RESPONSE

Mode that transforms response entities after their handling by the attached Restlet.

See Also:

Constant Field Values

Constructor Detail

Transformer

public Transformer(int mode,
                   Representation transformSheet)

Constructor.

Parameters:

mode - The transformation mode.

transformSheet - The XSLT transform sheet to apply to message entities.

Method Detail

afterHandle

protected void afterHandle(Request request,
                           Response response)

Overrides:

afterHandle in class Filter

beforeHandle

protected int beforeHandle(Request request,
                           Response response)

Overrides:

beforeHandle in class Filter

canTransform

protected boolean canTransform(Representation representation)

Indicates if the filter can transform the given message entity. By default, it always returns true.

Parameters:

representation - The entity representation to test.

Returns:

True if the transformation can be applied.

getMode

public int getMode()

Returns the transformation mode. See MODE_* constants.

Returns:

The transformation mode.

getResultCharacterSet

public CharacterSet getResultCharacterSet()

Returns the character set of the result representation. The default value is null.

Returns:

The character set of the result representation.

getResultEncodings

public java.util.List<Encoding> getResultEncodings()

Returns the modifiable list of encodings of the result representation.

Returns:

The encoding of the result representation.

getResultLanguages

public java.util.List<Language> getResultLanguages()

Returns the modifiable list of languages of the result representation.

Returns:

The language of the result representation.

getResultMediaType

public MediaType getResultMediaType()

Returns the media type of the result representation. The default value is MediaType.APPLICATION_XML.

Returns:

The media type of the result representation.

getTransformSheet

public Representation getTransformSheet()

Returns the XSLT transform sheet to apply to message entities.

Returns:

The XSLT transform sheet to apply to message entities.

setMode

public void setMode(int mode)

Sets the transformation mode. See MODE_* constants.

Parameters:

mode - The transformation mode.

setResultCharacterSet

public void setResultCharacterSet(CharacterSet resultCharacterSet)

Sets the character set of the result representation.

Parameters:

resultCharacterSet - The character set of the result representation.

setResultEncodings

public void setResultEncodings(java.util.List<Encoding> resultEncodings)

Sets the encodings of the result representation.

Parameters:

resultEncodings - The encodings of the result representation.

setResultLanguages

public void setResultLanguages(java.util.List<Language> resultLanguages)

Sets the languages of the result representation.

Parameters:

resultLanguages - The languages of the result representation.

setResultMediaType

public void setResultMediaType(MediaType resultMediaType)

Sets the media type of the result representation.

Parameters:

resultMediaType - The media type of the result representation.

setTransformSheet

public void setTransformSheet(Representation transformSheet)

Sets the XSLT transform sheet to apply to message entities.

Parameters:

transformSheet - The XSLT transform sheet to apply to message entities.

transform

public Representation transform(Representation source)

Transforms a source XML representation by applying an XSLT transform sheet to it.

Parameters:

source - The source XML representation.

Returns:

The generated result representation.