public abstract class

AbstractTransform

extends Object
implements Transform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractTransform class is an abstract base class that implements the Transform interface. It provides default implementation of many methods defined in this interface.

Summary

Public Constructors
AbstractTransform()
Public Methods
boolean canTransform(Transformable data)
Checks that the transform supports specified data object and that object is in the state supported by this transform.
FormalParameters getFormalParams()
Returns the collection of formal parameters associated with this transform.
String getID()
Returns the unique name of the component to be used as the ID for its shell
MarkupOutput getPreview()
Produces a preview output for this transform.
boolean isPreviewAvailable()
Returns true if this transform supports preview functionality, false otherwise.
boolean isResolved()
Returns whether each required formal parameter has a value associated with it.
boolean supports(Class type)
Returns true if the transform supports objects of specified type.
boolean supports(Transformable data)
Returns true if the transform supports the specified data object.
Protected Methods
void addFormalParam(FormalParameterImpl formal)
This method is used to add a FormalParameterImpl object to the transform.
static List<Integer> getEvents(RequestKeys rkeys)
Determines event(s) triggered from the request keys.
FormalParameterImpl removeFormalParam(String name)
Removes the formal parameter with the given name from the formal parameters collection.
void setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa)
Used for internal housekeeping.
void setDeprecated(FormalParameter fp, String desc)
Used for internal housekeeping.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Public Constructors

public AbstractTransform ()

Public Methods

public 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 FormalParameters getFormalParams ()

Returns the collection of formal parameters associated with this transform.

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

public 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 MarkupOutput getPreview ()

Produces a preview output for this transform.

Returns
  • a MarkupOutput containing preview of this transform.
Throws
UnsupportedOperationException

public boolean isPreviewAvailable ()

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

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

public boolean isResolved ()

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

Returns
  • whether each required formal parameter has a value.

public boolean supports (Class type)

Returns true if the transform supports objects of specified type.

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

public 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.

Protected Methods

protected void addFormalParam (FormalParameterImpl formal)

This method is used to add a FormalParameterImpl object to the transform.

Parameters
formal The formal parameter to add to the transform. This object should be an object of type FormalParameterImpl.
Throws
IllegalArgumentException Thrown if the formal parameter passed is not valid.

protected static List<Integer> getEvents (RequestKeys rkeys)

Determines event(s) triggered from the request keys.

protected FormalParameterImpl removeFormalParam (String name)

Removes the formal parameter with the given name from the formal parameters collection.

Parameters
name The name of the formal parameter to remove from the collection.
Returns

protected void setAnnotation (FormalParameter fp, FormalParameterAnnotation fpa)

Used for internal housekeeping.

Throws
IllegalArgumentException if arguments are null

protected void setDeprecated (FormalParameter fp, String desc)

Used for internal housekeeping.

Throws
IllegalArgumentException if arguments are null