com.sapportals.wcm.service.pipeline

Interface IXsltPipelineService

All Superinterfaces:

IService

public interface IXsltPipelineService
extends IService

The XSLT-Pipeline is a specialized version of the pipeline.

XSLT-Pipeline is used to transform XML into another form via XSL. The code sample creates a XSLT pipeline and transforms a XML resource:

 IResource xml = ...
 IResource xsl = ...
 IXsltPipelineService xsltpl;
 xsltpl = (IXsltPipelineService) ResourceFactory.getInstance().getServiceFactory().
           getService("xsltpipeline");
 IContent content = xsltpl.handle(ProducerFromResource(xml),
                                  ProducerFromResource(xsl),
                                  null)
 

Copyright (c) SAP Portals Europe GmbH 2001

Field Summary

static String

XSLTPIPELINE_SERVICE

Method Summary

String	getFormat() WARNING: Deprecated Method (This version is error prone) !!!
IContent	handle(InputStream xml, InputStream xsl, Hashtable properties) This method calls the XSLT processor.
IContent	handle(InputStream xml, InputStream xsl, Hashtable properties, String mime) This method calls the XSLT processor.
IContent	handle(IProducer xml, IProducer xsl, Hashtable properties) This method calls the XSLT processor.
IContent	handle(IProducer xml, IProducer xsl, Hashtable properties, String mime) This method calls the XSLT processor.
IContent	handle(IProducer xml, String xslUrl, Hashtable properties) This method calls the XSLT processor.
IContent	handle(IProducer xml, String xslUrl, Hashtable properties, String mime) This method calls the XSLT processor.
IContent	handle(String xmlUrl, String xslUrl, Hashtable properties) This method calls the XSLT processor.
IContent	handle(String xmlUrl, String xslUrl, Hashtable properties, String mime) This method calls the XSLT processor.
void	setFormat(String mime) WARNING: Deprecated Method (This version is error prone) !!!

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Field Detail

XSLTPIPELINE_SERVICE

static final String XSLTPIPELINE_SERVICE

See Also:

Constant Field Values

Method Detail

setFormat

void setFormat(String mime)

WARNING: Deprecated Method (This version is error prone) !!! Use methods which use mime type directly. Method sets the mime type.

Parameters:

mime - Mime type e.g. "text/html".

getFormat

String getFormat()

WARNING: Deprecated Method (This version is error prone) !!! Method gets the mime type.

Returns:

MimeType

handle

IContent handle(IProducer xml,
                IProducer xsl,
                Hashtable properties)
                throws WcmException

This method calls the XSLT processor. The return value contains the result of the XSL transformation. For a better performance it is recommended to use ProducerFromResource for the XSL source.

Parameters:

xsl - XSL Source. If NULL the XSL stylesheet must be defined in the XML.

properties - Properties to pass to processor and formatter. If null then no parameters are passed. See IPipelineService.handle(IProducer, IProcessor, Hashtable)

xml - TBD: Description of the incoming method parameter

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(IProducer xml,
                IProducer xsl,
                Hashtable properties,
                String mime)
                throws WcmException

This method calls the XSLT processor. The return value contains the result of the XSL transformation. For a better performance it is recommended to use ProducerFromResource for the XSL source.

Parameters:

xml - XML Source. See also IPipelineService.handle(IProducer, IProcessor, Hashtable)

xsl - XSL Source. If NULL the XSL stylesheet must be defined in the XML.

properties - Properties to pass to processor and formatter. If null then no parameters are passed. See IPipelineService.handle(IProducer, IProcessor, Hashtable)

mime - Mime type for formatter. If mime=null then "text/html" is used

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(InputStream xml,
                InputStream xsl,
                Hashtable properties)
                throws WcmException

This method calls the XSLT processor. It should only be used for debugging. The return value contains the result of the XSL transformation. Use methods with the Iproducer interface instead.

Parameters:

xml - Inputstream to the XML.

xsl - Inputstream to the XSL. If NULL the XSL stylesheet must be defined in the XML.

properties - Properties to pass to processor and formatter. If null then no parameters are passed. See IPipelineService.handle(IProducer, IProcessor, Hashtable)

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(InputStream xml,
                InputStream xsl,
                Hashtable properties,
                String mime)
                throws WcmException

This method calls the XSLT processor. It should only be used for debugging. The return value contains the result of the XSL transformation. Use methods with the Iproducer interface instead.

Parameters:

xml - Inputstream of XML.

xsl - Inputstream of XSL. If NULL the XSL stylesheet must be defined in the XML.

properties - Properties to pass to processor and formatter. If null then no parameters are passed. See IPipelineService.handle(IProducer, IProcessor, Hashtable)

mime - Mime type for formatter. If mime=null then "text/html" is used

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(IProducer xml,
                String xslUrl,
                Hashtable properties)
                throws WcmException

This method calls the XSLT processor. The return value contains the result of the XSL transformation.

Parameters:

xml - XML source

xslUrl - XSL source

properties - Properties to pass to processor and formatter. If null then no parameters are passed. See IPipelineService.handle(IProducer, IProcessor, Hashtable)

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(IProducer xml,
                String xslUrl,
                Hashtable properties,
                String mime)
                throws WcmException

This method calls the XSLT processor. The return value contains the result of the XSL transformation.

Parameters:

xml - XML source

xslUrl - XSL source

properties - Properties to pass to processor and formatter. If null then no parameters are passed. See IPipelineService.handle(IProducer, IProcessor, Hashtable)

mime - Mime type for formatter. If mime=null then "text/html" is used

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(String xmlUrl,
                String xslUrl,
                Hashtable properties)
                throws WcmException

This method calls the XSLT processor. The return value contains the result of the XSL transformation.

Parameters:

xmlUrl - XML source

xslUrl - XSL source

properties - (optional) Properties are passed to the XSLT processor.

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

handle

IContent handle(String xmlUrl,
                String xslUrl,
                Hashtable properties,
                String mime)
                throws WcmException

This method calls the XSLT processor. The return value contains the result of the XSL transformation.

Parameters:

xmlUrl - XML source

xslUrl - XSL source

properties - (optional) Properties are passed to the XSLT processor.

mime - Mime type for formatter. If mime=null then "text/html" is used

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM