public interface

Transformable

com.microstrategy.web.beans.Transformable
Known Indirect Subclasses

Class Overview

This interface represents objects that support Transform functionality.

Summary

Public Methods
abstract TransformInstance addTransform(Transform transform)
Adds a Transform object into the collection of transforms.
abstract TransformInstance addTransformByClass(String transformClass)
Adds into the collection of transforms a Transform object with the specified fully qualified class name.
abstract TransformInstance addTransformByStyle(String styleName)
Adds into the collection of transforms a Transform object with the specified style name.
abstract TransformInstance addTransformByStyle(String styleName, StyleRequestContext context)
Adds into the collection of transforms a Transform object with the specified style name.
abstract void clearTransforms()
Deletes all transforms added to the object
abstract BeanContext getBeanContext()
Returns the BeanContext instance.
abstract String getMessageString(String key)
Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any.
abstract Enumeration getMyTransformInstances()
abstract TransformInstance getTransformInstance()
Returns the default TransformInstance object
abstract TransformInstance getTransformInstance(String key)
Returns the TransformInstance object with the specified key.
abstract Enumeration getTransformInstances()
Retuns a java.util.Enumeration over all the TransformInstance objects.
abstract int getType()
Returns the transformable type as in EnumWebTransformableType.
abstract boolean hasTransform()
Returns a boolean value indicating whether there is a default TransformInstance object.
abstract boolean hasTransform(String key)
Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.
abstract void invalidateTransformCache()
This method is called by any transformable object after collecting data
abstract void setBeanContext(BeanContext beanContext)
Sets an instance of BeanContext on the current Transformable object.
abstract MarkupOutput transform(String key)
Performs transform on a component by the TransformInstance with the specified key.
abstract MarkupOutput transform()
Performs transform on a component by the default TransformInstance object.

Public Methods

public abstract TransformInstance addTransform (Transform transform)

Adds a Transform object into the collection of transforms. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters
transform a Transform to add
Returns
  • a TransformInstance holding the transform added.

public abstract TransformInstance addTransformByClass (String transformClass)

Adds into the collection of transforms a Transform object with the specified fully qualified class name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters
transformClass the fully qualified class name of the Transform object to be added.
Returns
  • a TransformInstance holding the transform added.
Throws
WebTransformException thrown if the specified transform can not be found or instantiated.

public abstract TransformInstance addTransformByStyle (String styleName)

Adds into the collection of transforms a Transform object with the specified style name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters
styleName the style name in a style catalog.
Returns
  • a TransformInstance holding the transform added.
Throws
WebTransformException thrown if the specified transform can not be instantiated.

public abstract TransformInstance addTransformByStyle (String styleName, StyleRequestContext context)

Adds into the collection of transforms a Transform object with the specified style name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters
styleName the style name in a style catalog.
context the StyleRequestContext object.
Returns
  • a TransformInstance holding the transform added.
Throws
WebTransformException thrown if the specified transform can not be instantiated.

public abstract void clearTransforms ()

Deletes all transforms added to the object

public abstract BeanContext getBeanContext ()

Returns the BeanContext instance.

Returns
  • the BeanContext instance.

public abstract String getMessageString (String key)

Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any. The string descriptor is mapped by the specified key. A String of value "ERROR" is returned if there is no such a string descriptor.

Parameters
key the key mapped to a string descriptor in a Messages
Returns
  • the string descriptor from a Messages.

public abstract Enumeration getMyTransformInstances ()

public abstract TransformInstance getTransformInstance ()

Returns the default TransformInstance object

Returns
  • the default TransformInstance object; null if there is no default TransformInstance object.

public abstract TransformInstance getTransformInstance (String key)

Returns the TransformInstance object with the specified key.

Parameters
key the key of a TransformInstance.
Returns
  • the TransformInstance object with the specified key.
Throws
KeyDoesNotExistException thrown if the key is not found.

public abstract Enumeration getTransformInstances ()

Retuns a java.util.Enumeration over all the TransformInstance objects.

Returns
  • a java.util.Enumeration over all the TransformInstance objects.

public abstract int getType ()

Returns the transformable type as in EnumWebTransformableType.

Returns
  • the transformable type.

public abstract boolean hasTransform ()

Returns a boolean value indicating whether there is a default TransformInstance object.

Returns
  • true if there is a default transform.

public abstract boolean hasTransform (String key)

Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.

Parameters
key the key of a Transform
Returns
  • true if there is such a TransformInstance with the specified key.

public abstract void invalidateTransformCache ()

This method is called by any transformable object after collecting data

public abstract void setBeanContext (BeanContext beanContext)

Sets an instance of BeanContext on the current Transformable object.

Parameters
beanContext a BeanContext object.

public abstract MarkupOutput transform (String key)

Performs transform on a component by the TransformInstance with the specified key. This method is synchronized on the TransformInstance object.

Parameters
key the key of a TransformInstance object.
Returns
  • a MarkupOutput object containing the result of transform.
Throws
TransformDoesNotExistException thrown if there is no such a TransformInstance or the transform can not be performed.
KeyDoesNotExistException thrown if the key is not found.

public abstract MarkupOutput transform ()

Performs transform on a component by the default TransformInstance object. This method is synchronized on the TransformInstance object.

Returns
  • a MarkupOutput object containing the result of transform.
Throws
TransformDoesNotExistException thrown if there is no default TransformInstance or the transform can not be performed.