Package com.microstrategy.web.blocks.xforms

Class BlockTransformScript

java.lang.Object

com.microstrategy.web.blocks.xforms.BlockTransformScript

public class BlockTransformScript
extends java.lang.Object

A Block Transform Script is a textual script that specifies how to transform a given Block tree. Each "step" of this script is performed sequentially by the way of a given Block Transform (see BlockTransform). The result is either a transformed Block tree (which has the same root) or a new Block tree which may be a subset of the original Block tree or a completely newly generated result.

The process of executing a script involves two separate steps:

1. First, the textual script is parsed (see setScript(String)) and converted into an "executable" form
2. Then, it is executed on a given "root Block" (see execute(Block)).

The result of the execute call is the new root Block. At each point a checked exception may be raised:

• If the script is malformed, an BlockTransformScriptInvalid exception is raised.
• If the script fails in the process of execution, a BlockTransformExecutionFailure exception is raised.

Constructor Summary

Constructors

Constructor	Description
BlockTransformScript()

Method Summary

Modifier and Type	Method	Description
Block	execute(Block rootBlock)
java.lang.String	getScript()
void	setScript(java.lang.String script)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockTransformScript

public BlockTransformScript()

Method Detail

setScript

public void setScript(java.lang.String script)
               throws BlockTransformScriptInvalid

Throws:

BlockTransformScriptInvalid

getScript

public java.lang.String getScript()

execute

public Block execute(Block rootBlock)
              throws BlockTransformExecutionFailure

Throws:

BlockTransformExecutionFailure