com.tridion.web

Class XSLTProcessor

java.lang.Object

com.tridion.web.XSLTProcessor

Direct Known Subclasses:

JSPXSLTProcessor

public class XSLTProcessor
extends Object

The XSLTProcessor applies XSLT on the XML content of an XML Component Presentation.

Constructor Summary

Constructors

Constructor and Description
XSLTProcessor() Creates a new XSLTProcessor.

Method Summary

Modifier and Type	Method and Description
String	getString(int publicationId, int componentId, int componentTemplateId) Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation.
String	getString(String componentURIString, String templateURIString) Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation.
String	getString(XMLComponentPresentation cp, int thePageId) Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation.
String	getString(XMLComponentPresentation componentPresentation, URL url) Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation.
String	getString(XMLQueryResult input, int publicationId, int componentTemplateId) Applies a Dynamic Template (XSLT) on an XMLQueryResult and returns the result as a String.
String	getString(XMLQueryResult input, String publicationURIString, String templateURIString) Applies a Dynamic Template (XSLT) on an XMLQueryResult and returns the result as a String.
Transformer	getTransformer(int publicationId, int componentTemplateId) Creates a Transformer from a Dynamic Template.
void	initPageURI(String pageURI) Set the page URI to use to pass to the XSL transformation as a parameter, in case a page identifier is not specified in the API call (the default that can be overruled).
protected void	setParameters(Transformer transformer, int publicationId, int thePageId, int componentId, int componentTemplateId) Sets the parameters for the stylesheet, which are publicationId, pageId, componentId, componentTemplateId, publicationURI, pageURI, componentURI, componentTemplateURI.

Methods inherited from class java.lang.Object

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

Constructor Detail

XSLTProcessor

public XSLTProcessor()

Creates a new XSLTProcessor.

Method Detail

initPageURI

public void initPageURI(String pageURI)

Set the page URI to use to pass to the XSL transformation as a parameter, in case a page identifier is not specified in the API call (the default that can be overruled).

Parameters:

pageURI - The page URI to pass to the XSLT processor as a parameter. Incorrect URIs are simply ignored.

getString

public String getString(XMLComponentPresentation cp,
                        int thePageId)

Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation. If no XSLT for the XML Component Presentation can be found, or another error occurs, an empty string will be returned.

Parameters:

thePageId - The id of the page on which the dynamic assembly occurs.

Returns:

A String containing the result of the transformation or an empty String if an error occurs.

getString

public String getString(XMLComponentPresentation componentPresentation,
                        URL url)

Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation. If no XSLT for the XML Component Presentation can be found, or another error occurs, an empty string will be returned.

Parameters:

url - This parameter isn't used.

Returns:

A String containing the result of the transformation or an empty String if an error occurs.

getString

public String getString(String componentURIString,
                        String templateURIString)

Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation. This XML Component Presentation is identified by the Component and Component Template which are passed as parameters.

If no XSLT for the XML Component Presentation or the XML Component Presentation itself can be found, or another error occurs, an empty string will be returned.

Parameters:

componentURIString - The tcm:uri of the Component.

templateURIString - The tcm:uri of the Component Template.

Returns:

A String containing the result of the transformation or an empty String if an error occurs.

getString

public String getString(int publicationId,
                        int componentId,
                        int componentTemplateId)

Applies the Dynamic Component Template, which is an XSLT, to the contents of an XML Component Presentation. This XML Component Presentation is identified by the Component and Component Template which are passed as parameters.

If no XSLT for the XML Component Presentation or the XML Component Presentation itself can be found, or another error occurs, an empty string will be returned.

Parameters:

publicationId - The id of the Publication in which the Component Presentation is located.

componentId - The id of the Component.

componentTemplateId - The id of the Component Template.

Returns:

A String containing the result of the transformation or an empty String if an error occurs.

getString

public String getString(XMLQueryResult input,
                        int publicationId,
                        int componentTemplateId)

Applies a Dynamic Template (XSLT) on an XMLQueryResult and returns the result as a String. If no XSLT for the XML Component Presentation or the XML Component Presentation itself can be found, or another error occurs, an empty string will be returned.

Parameters:

input - The XMLQueryResult that should be transformed.

publicationId - The id of the Publication in which the Component Template is located.

componentTemplateId - The id of the Component Template.

Returns:

A String containing the result of the transformation, or an empty String if an error occurs.

getString

public String getString(XMLQueryResult input,
                        String publicationURIString,
                        String templateURIString)

Applies a Dynamic Template (XSLT) on an XMLQueryResult and returns the result as a String. If no XSLT for the XML Component Presentation or the XML Component Presentation itself can be found, or another error occurs, an empty string will be returned.

Parameters:

input - The XMLQueryResult that should be transformed.

publicationURIString - The tcm:uri of the Publication in which the Component Template is located.

templateURIString - The tcm:uri of the Component Template.

Returns:

A String containing the result of the transformation, or an empty String if an error occurs.

getTransformer

public Transformer getTransformer(int publicationId,
                                  int componentTemplateId)
                           throws TransformerException,
                                  StorageException

Creates a Transformer from a Dynamic Template. If the Object Cache is enabled then the transfomerms are cached instead of of being created from scratch every time.

Parameters:

publicationId - The id of the Publication in which the Component Template is located.

componentTemplateId - The id of the Component Template.

Returns:

A Transformer for the XSLT, or null if one could not be found.

Throws:

TransformerException - When a Transformer could not be created for the XSLT.

StorageException

setParameters

protected void setParameters(Transformer transformer,
                             int publicationId,
                             int thePageId,
                             int componentId,
                             int componentTemplateId)

Sets the parameters for the stylesheet, which are publicationId, pageId, componentId, componentTemplateId, publicationURI, pageURI, componentURI, componentTemplateURI.

Parameters:

transformer - the transformer for which the parameters should be set

publicationId - the id of the Publication

componentId - the id of the Component

componentTemplateId - the id of the Component Template