DataResultTransform

extends AbstractTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.webservices.DataResultTransform

Summary

Fields
protected FormalParameter	_baseNode
protected int	_numHeaders
protected int	_numRowHeaders
protected FormalParameter	_outputFormat

Public Constructors
	DataResultTransform()

Public Methods
FormalParameter	addFormalParameter(String name, int type, Object defaultValue, String description) Adds a formal parameter for this transform with the given information
String	getDescription()
Class	getSupportedBeanType()
TagsFactory	getTagsFactory() Convenience method for obtaining an instance of the `TagsFactory` class.
void	transform(Transformable data, MarkupOutput out)

[Expand]

Inherited Methods

From class com.microstrategy.web.transform.AbstractTransform

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.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
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.
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.
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.

From class java.lang.Object

From interface com.microstrategy.web.transform.Transform

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.

Fields

protected FormalParameter _baseNode

protected int _numHeaders

protected int _numRowHeaders

protected FormalParameter _outputFormat

Public Constructors

public DataResultTransform ()

Public Methods

public FormalParameter addFormalParameter (String name, int type, Object defaultValue, String description)

Adds a formal parameter for this transform with the given information

Parameters

name	the name of the formal parameter
type	the type of the formal parameter, as defined in the `FormalParameter` constants.
defaultValue	the default value
description	Description of the FP, to use by the style catalog.

Returns

the FormalParameter created.

public String getDescription ()

public Class getSupportedBeanType ()

public TagsFactory getTagsFactory ()

Convenience method for obtaining an instance of the TagsFactory class.

Returns

a TagsFactory instance to use for generating Tag instances

Classes

Exceptions

DataResultTransform

Summary

Fields

protected FormalParameter _baseNode

protected int _numHeaders

protected int _numRowHeaders

protected FormalParameter _outputFormat

Public Constructors

public DataResultTransform ()

Public Methods

public FormalParameter addFormalParameter (String name, int type, Object defaultValue, String description)

Parameters

Returns

public String getDescription ()

public Class getSupportedBeanType ()

public TagsFactory getTagsFactory ()

Returns

public void transform (Transformable data, MarkupOutput out)