com.sap.portal.httpconnectivity.transformationservice

Interface ITransformerInformation

All Superinterfaces:

Cloneable, ITransformerProperties

public interface ITransformerInformation
extends ITransformerProperties

The interface that represents transformer information, and is used to initialize transformers, get their properties and to specify transformers. Transformer information includes component name, transformer name, version information, from what scheme it can transform and to what scheme it can transform. It also contains the tranformer type. The following types are available:

• BUILT_IN: The transformer is provided by the transformation service. The transformers provided are: RSS, Busdoc and XHTMLB.
• PERSISTENT: The transformer is supplied by the transformation provider. All transformers that are not BUILT_IN are PERSISTENT.
• TEMPORARY: The transformer is temporarily supplied by a regular portal application. Can be used in a single call to the transformation service. The transformer remains alive as long as the supplier is alive.

An instance of this interface must be created by a call to ITransformerService.createTransformerInformation.
In most cases, the information reflects the data specified in the Transformers.xml configuration file.

See Also:

ITransformerService, TransformersProvider

Field Summary

static String	TRANSFORMER_IMPL_TYPE_SAX A constant that defines the SAX transformer implementation type.
static String	TRANSFORMER_IMPL_TYPE_XSL A constant that defines the XSL transformer implementation type.
static String	TRANSFROMER_KEY_END The key suffix.
static String	TRANSFROMER_KEY_SEPARATOR The separator for key elements.
static String	TRANSFROMER_KEY_START The key prefix.

Method Summary

Object	clone() Creates a clone of the transformer information.
String	getComponentName() Gets the name of the portal component or portal service that registered the transformer.
String	getDescription() Gets the general description of the transformer.
String	getFromSchemeURI() Gets the URI for the transformer output scheme.
String	getImplementationType() Gets the implementation type.
String	getKey() Gets the transformer key.
String	getLocation() Gets the location of the source.
String	getName() Gets the transformer name.
String	getToSchemeURI() Gets the URI for the transformer input scheme from which the transformer gets the XML data.
TransformerType	getType() Gets the transformer type.
Float	getVersion() Gets the version of the transformer.
void	setImplementationType(String trnsImplType) Sets the implementation type to SAX or XSL.
void	setLocation(String location) Sets the path for the XSL file or the full class name of the SAX handler.

Methods inherited from interface com.sap.portal.httpconnectivity.transformationservice.ITransformerProperties

getInputProperties

Field Detail

TRANSFORMER_IMPL_TYPE_XSL

static final String TRANSFORMER_IMPL_TYPE_XSL

A constant that defines the XSL transformer implementation type.

See Also:

Constant Field Values

TRANSFORMER_IMPL_TYPE_SAX

static final String TRANSFORMER_IMPL_TYPE_SAX

A constant that defines the SAX transformer implementation type.

See Also:

Constant Field Values

TRANSFROMER_KEY_SEPARATOR

static final String TRANSFROMER_KEY_SEPARATOR

The separator for key elements.

See Also:

Constant Field Values

TRANSFROMER_KEY_START

static final String TRANSFROMER_KEY_START

The key prefix.

See Also:

Constant Field Values

TRANSFROMER_KEY_END

static final String TRANSFROMER_KEY_END

The key suffix.

See Also:

Constant Field Values

Method Detail

getFromSchemeURI

String getFromSchemeURI()

Gets the URI for the transformer output scheme.

Returns:

output scheme URI

getToSchemeURI

String getToSchemeURI()

Gets the URI for the transformer input scheme from which the transformer gets the XML data.

Returns:

input scheme URI

getKey

String getKey()

Gets the transformer key. The transformer key is unique.

Returns:

transformer key

getName

String getName()

Gets the transformer name. The name must be unique for an application component.

Returns:

the transformer name

getComponentName

String getComponentName()

Gets the name of the portal component or portal service that registered the transformer.

Returns:

the component name

getVersion

Float getVersion()

Gets the version of the transformer.

Returns:

the transformer version

getType

TransformerType getType()

Gets the transformer type.

Returns:

the transformer type

clone

Object clone()
             throws CloneNotSupportedException

Creates a clone of the transformer information.

Returns:

a copy of the transformer information object

Throws:

CloneNotSupportedException - if cloning is not supported

getLocation

String getLocation()

Gets the location of the source. If the source location does not exist, returns null.

Returns:

the location of the transformer handler

setLocation

void setLocation(String location)

Sets the path for the XSL file or the full class name of the SAX handler.

Parameters:

location - XSL URI or SAX full class name

setImplementationType

void setImplementationType(String trnsImplType)

Sets the implementation type to SAX or XSL.

Parameters:

trnsImplType - the transformer implementation type

getImplementationType

String getImplementationType()

Gets the implementation type. The returned value can be SAX or XSL.

Returns:

the implementation type

getDescription

String getDescription()

Gets the general description of the transformer.

Returns:

the transformer description

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-ADMIN	[sap.com] tc/ep/admin/api/extd	api	EP-PIN