public interface

BlockVisitor

com.microstrategy.web.blocks.BlockVisitor
Known Indirect Subclasses

Summary

Public Methods
abstract void visitBlockEnd(Block block, BlockTarget parent)
Invoked for each Block after all of its properties are visited.
abstract boolean visitBlockStart(Block block, BlockTarget parent)
Invoked for each Block before any of its properties are visited.
abstract boolean visitCompositeProperty(BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)
Invoked for each composite (Block or BlockList) Block Property.
abstract void visitListEnd(BlockList blockList, BlockTarget parent)
Invoked at the end of a BlockList.
abstract boolean visitListStart(BlockList blockList, BlockTarget parent)
Invoked at the beginning of a BlockList.
abstract void visitScalarProperty(BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)
Invoked for each scalar (non-Block, non-BlockList) Block Property.
abstract void visitUnassignedProperty(BlockProperty blockProperty, Block parent)
Invoked for each unassigned block property.

Public Methods

public abstract void visitBlockEnd (Block block, BlockTarget parent)

Invoked for each Block after all of its properties are visited.

Parameters
block The Block being visited.
parent The BlockTarget that contains the supplied Block.

public abstract boolean visitBlockStart (Block block, BlockTarget parent)

Invoked for each Block before any of its properties are visited.

Parameters
block The Block being visited.
parent The BlockTarget that contains the supplied Block.
Returns

public abstract boolean visitCompositeProperty (BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)

Invoked for each composite (Block or BlockList) Block Property. In particular, it is only invoked for BlockProperty instances whose value is non-null.

Parameters
blockProperty The BlockProperty that has an assigned value.
parent The Block that contains this BlockProperty.
firstAssignedProperty Whether or not this is the first assigned property of the Block.
Returns
  • True if the Block Property should traverse the composite value of this property. If false, there is no traversal.

public abstract void visitListEnd (BlockList blockList, BlockTarget parent)

Invoked at the end of a BlockList.

Parameters
blockList The BlockList that we are visiting.
parent The BlockTarget that contains the supplied BlockList.

public abstract boolean visitListStart (BlockList blockList, BlockTarget parent)

Invoked at the beginning of a BlockList.

Parameters
blockList The BlockList that we are visiting.
parent The BlockTarget that contains the supplied BlockList.
Returns
  • True if the Block List should traverse each of the elements of its list. If false, the list elements are not traversed.

public abstract void visitScalarProperty (BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)

Invoked for each scalar (non-Block, non-BlockList) Block Property. In particular, it is only invoked for BlockProperty instances whose value is non-null.

Parameters
blockProperty The BlockProperty that has an assigned value.
parent The Block that contains this BlockProperty.
firstAssignedProperty Whether or not this is the first assigned property of the Block.

public abstract void visitUnassignedProperty (BlockProperty blockProperty, Block parent)

Invoked for each unassigned block property. An "unassigned" BlockProperty is one whose value is null.

Parameters
blockProperty The BlockProperty that has an unassigned value.
parent The Block that contains this BlockProperty.