com.sap.portal.httpconnectivity.transformationservice
Interface ITransformerInformation

All Superinterfaces:

java.lang.Cloneable, ITransformerProperties

public interface ITransformerInformation

extends ITransformerProperties

Provide an interface to hold transformer information. It is used to initialize transformers, get their properties and for choosing transformers. The transformer information holds component name, transformer name, version, from what scheme can it transform and to what scheme it can transform. It also hold the tranformer type: Built-in, Temporary or Persistent.
Instance of this interface must be created by a call to ITransformerService.createTransformerInformation.

See Also:

ITransformerService.createTransformerInformation(java.lang.String,java.lang.String,java.lang.Float,com.sap.portal.httpconnectivity.transformationservice.TransformerType,java.lang.String,java.lang.String,java.lang.String)

Field Summary

static java.lang.String	TRANSFORMER_IMPL_TYPE_SAX SAX transformer type marker
static java.lang.String	TRANSFORMER_IMPL_TYPE_XSL XSL transformer type marker
static java.lang.String	TRANSFROMER_KEY_END Postfix of the key
static java.lang.String	TRANSFROMER_KEY_SEPARATOR Separator between the key parts
static java.lang.String	TRANSFROMER_KEY_START Prefix of the key

Method Summary

java.lang.Object	clone() Clones the trnasformer information
java.lang.String	getComponentName() Getting the name of the component in-charge for the transformer
java.lang.String	getDescription() Gets the transformer description
java.lang.String	getFromSchemeURI() Get the URI representing the tranformer output scheme
java.lang.String	getImplementationType() Gets the implementation type
java.lang.String	getKey() Getting the transformer key.
java.lang.String	getLocation() Gets the location of the source of the transformer
java.lang.String	getName() Getting the transformer name
java.lang.String	getToSchemeURI() Get the URI representing the tranformer input scheme
TransformerType	getType() Getting the transformer type
java.lang.Float	getVersion() Getting the transformer version
void	setImplementationType(java.lang.String trnsImplType) Sets the implementation type: SAX or XSL
void	setLocation(java.lang.String location) Set the location of the file path of XSL file or the full class name of SAX handler.

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

getInputProperties

Field Detail

TRANSFORMER_IMPL_TYPE_XSL

public static final java.lang.String TRANSFORMER_IMPL_TYPE_XSL

XSL transformer type marker

TRANSFORMER_IMPL_TYPE_SAX

public static final java.lang.String TRANSFORMER_IMPL_TYPE_SAX

SAX transformer type marker

TRANSFROMER_KEY_SEPARATOR

public static final java.lang.String TRANSFROMER_KEY_SEPARATOR

Separator between the key parts

TRANSFROMER_KEY_START

public static final java.lang.String TRANSFROMER_KEY_START

Prefix of the key

TRANSFROMER_KEY_END

public static final java.lang.String TRANSFROMER_KEY_END

Postfix of the key

Method Detail

getFromSchemeURI

public java.lang.String getFromSchemeURI()

Get the URI representing the tranformer output scheme

Returns:

output scheme URI

getToSchemeURI

public java.lang.String getToSchemeURI()

Get the URI representing the tranformer input scheme

Returns:

input scheme URI

getKey

public java.lang.String getKey()

Getting the transformer key. The transformer key is unique

Returns:

transformer key

getName

public java.lang.String getName()

Getting the transformer name

Returns:

transformer name

getComponentName

public java.lang.String getComponentName()

Getting the name of the component in-charge for the transformer

Returns:

component name

getVersion

public java.lang.Float getVersion()

Getting the transformer version

Returns:

transformer version

getType

public TransformerType getType()

Getting the transformer type

Returns:

type of the transformer

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the trnasformer information

Overrides:

clone in class java.lang.Object

Returns:

ITransformerInformation - a copy of the object

Throws:

java.lang.CloneNotSupportedException - when cloning is not supported

getLocation

public java.lang.String getLocation()

Gets the location of the source of the transformer

Returns:

the location of the transformer handler, can be null

setLocation

public void setLocation(java.lang.String location)

Set the location of the file path of XSL file or the full class name of SAX handler.

Parameters:

location - XSL URI or SAX full class name

setImplementationType

public void setImplementationType(java.lang.String trnsImplType)

Sets the implementation type: SAX or XSL

Parameters:

trnsImplType -

getImplementationType

public java.lang.String getImplementationType()

Gets the implementation type

Returns:

the implementation type

getDescription

public java.lang.String getDescription()

Gets the transformer description

Returns:

the transformer description