public interface

Transform

com.microstrategy.web.transform.Transform
Known Indirect Subclasses

Class Overview

The Transform interface is the base interface that is used for all bean-specific transforms.

Summary

Public Methods
abstract boolean canTransform(Transformable data)
Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String getDescription()
Returns a textual description of the transform.
abstract FormalParameters getFormalParams()
Returns the collection of formal parameters associated with this transform.
abstract String getID()
Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput getPreview()
This method is deprecated. This feature is not used
abstract Class getSupportedBeanType()
Returns a root class/interface supported by this transform.
abstract boolean isPreviewAvailable()
This method is deprecated. This feature is not used
abstract boolean isResolved()
Returns whether each required formal parameter has a value associated with it.
abstract boolean supports(Class beanClass)
Returns true if the transform supports objects of specified type.
abstract boolean supports(Transformable data)
Returns true if the transform supports the specified data object.
abstract void transform(Transformable data, MarkupOutput transOut)
Transforms the data object and appends result to the transOut.

Public Methods

public abstract boolean canTransform (Transformable data)

Checks that the transform supports specified data object and that object is in the state supported by this transform.

Returns
  • true if the transform supports specified data object and the object is in the state supported by this transform.

public abstract String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public abstract FormalParameters getFormalParams ()

Returns the collection of formal parameters associated with this transform.

Returns
  • FormalParameters interface, which is a collection of formal parameters.

public abstract String getID ()

Returns the unique name of the component to be used as the ID for its shell

Returns
  • the component's unique id

public abstract MarkupOutput getPreview ()

This method is deprecated.
This feature is not used

Produces a preview output for this transform.

Returns
  • a MarkupOutput containing preview of this transform.
Throws
UnsupportedOperationException in case the transform does not support preview functionality

public abstract Class getSupportedBeanType ()

Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.

Returns
  • a root class/interface supported by this transform.

public abstract boolean isPreviewAvailable ()

This method is deprecated.
This feature is not used

Returns true if this transform supports preview functionality, false otherwise.

Returns
  • true if this transform supports preview functionality, false otherwise.

public abstract boolean isResolved ()

Returns whether each required formal parameter has a value associated with it.

Returns
  • whether each required formal parameter has a value.

public abstract boolean supports (Class beanClass)

Returns true if the transform supports objects of specified type.

Parameters
beanClass the Java Class object representing bean type.
Returns
  • true if the transform supports objects of specified type.

public abstract boolean supports (Transformable data)

Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.

Parameters
data a transformable object
Returns
  • true if the transform supports the data object, false otherwise.

public abstract void transform (Transformable data, MarkupOutput transOut)

Transforms the data object and appends result to the transOut.

Parameters
data an object to transform. It must be of proper type supported by the concrete transform this method called on, or ClassCastExcetption will be thrown
transOut the MarkupOutput object where the transform result will be added.
Throws
ClassCastException if data is of the wrong type.