Package com.microstrategy.web.transform

Class AbstractTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

All Implemented Interfaces:

Transform

Direct Known Subclasses:

AbstractBasicReportTransform, AbstractExpressionTransform, AbstractLayoutTransform, AndroidMessageResultTransform, MobileChunkedGraphDataTransform, PrettyPrintTransform, ReportWorkingSetObjectsTransform, SampleTransform, SubscriptionsPageByAttributesTransform

public abstract class AbstractTransform
extends java.lang.Object
implements Transform

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

Since:

MicroStrategy Web 7.3.1 or earlier

Constructor Summary

Constructors

Constructor	Description
AbstractTransform()

Method Summary

Modifier and Type	Method	Description
protected void	addFormalParam(FormalParameterImpl formal)	This method is used to add a FormalParameterImpl object to the transform.
boolean	canTransform(Transformable data)	Checks that the transform supports specified data object and that object is in the state supported by this transform.
protected static java.util.List<java.lang.Integer>	getEvents(RequestKeys rkeys)	Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams()	Returns the collection of formal parameters associated with this transform.
java.lang.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.
protected FormalParameterImpl	removeFormalParam(java.lang.String name)	Removes the formal parameter with the given name from the formal parameters collection.
protected void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa)	Used for internal housekeeping.
protected void	setDeprecated(FormalParameter fp, java.lang.String desc)	Used for internal housekeeping.
boolean	supports(Transformable data)	Returns true if the transform supports the specified data object.
boolean	supports(java.lang.Class type)	Returns true if the transform supports objects of specified type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.Transform

getDescription, getSupportedBeanType, transform

Constructor Detail

AbstractTransform

public AbstractTransform()

Method Detail

getFormalParams

public FormalParameters getFormalParams()

Description copied from interface: Transform

Returns the collection of formal parameters associated with this transform.

Specified by:

getFormalParams in interface Transform

Returns:

FormalParameters interface, which is a collection of formal parameters.

addFormalParam

protected void addFormalParam(FormalParameterImpl formal)
                       throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - Thrown if the formal parameter passed is not valid.

removeFormalParam

protected FormalParameterImpl removeFormalParam(java.lang.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:

The FormalParameterImpl object that was removed, or null if no such parameter was found.

Since:

MicroStrategy Web 8.0.0

isResolved

public boolean isResolved()

Description copied from interface: Transform

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

Specified by:

isResolved in interface Transform

Returns:

whether each required formal parameter has a value.

isPreviewAvailable

public boolean isPreviewAvailable()

Description copied from interface: Transform

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

Specified by:

isPreviewAvailable in interface Transform

Returns:

true if this transform supports preview functionality, false otherwise.

getPreview

public MarkupOutput getPreview()
                        throws java.lang.UnsupportedOperationException

Description copied from interface: Transform

Produces a preview output for this transform.

Specified by:

getPreview in interface Transform

Returns:

a MarkupOutput containing preview of this transform.

Throws:

java.lang.UnsupportedOperationException - in case the transform does not support preview functionality

supports

public boolean supports(Transformable data)

Description copied from interface: Transform

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.

Specified by:

supports in interface Transform

Parameters:

data - a transformable object

Returns:

true if the transform supports the data object, false otherwise.

See Also:

Transform.canTransform(com.microstrategy.web.beans.Transformable)

supports

public boolean supports(java.lang.Class type)

Description copied from interface: Transform

Returns true if the transform supports objects of specified type.

Specified by:

supports in interface Transform

Parameters:

type - the Java Class object representing bean type.

Returns:

true if the transform supports objects of specified type.

canTransform

public boolean canTransform(Transformable data)

Description copied from interface: Transform

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

Specified by:

canTransform in interface Transform

Returns:

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

getID

public java.lang.String getID()

Description copied from interface: Transform

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

Specified by:

getID in interface Transform

Returns:

the component's unique id

Since:

MicroStrategy Web 8.0.0

setAnnotation

protected void setAnnotation(FormalParameter fp,
                             FormalParameterAnnotation fpa)

Used for internal housekeeping.

Throws:

java.lang.IllegalArgumentException - if arguments are null

Since:

MicroStrategy Web 8.0.0

setDeprecated

protected void setDeprecated(FormalParameter fp,
                             java.lang.String desc)

Used for internal housekeeping.

Throws:

java.lang.IllegalArgumentException - if arguments are null

Since:

MicroStrategy Web 8.0.0

getEvents

protected static java.util.List<java.lang.Integer> getEvents(RequestKeys rkeys)

Determines event(s) triggered from the request keys.

Since:

MicroStrategy Web 9.0.0