public class

BlockTransformScript

extends Object
java.lang.Object
   ↳ com.microstrategy.web.blocks.xforms.BlockTransformScript

Class Overview

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:

Summary

Public Constructors
BlockTransformScript()
Public Methods
Block execute(Block rootBlock)
String getScript()
void setScript(String script)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public BlockTransformScript ()

Public Methods

public Block execute (Block rootBlock)

public String getScript ()

public void setScript (String script)