public class

DefaultBlockVisitor

extends Object
implements BlockVisitor
java.lang.Object
   ↳ com.microstrategy.web.blocks.DefaultBlockVisitor
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A default implementation of the BlockVisitor interface. All methods are "no ops". Methods that return a boolean value return true. This class provides a simple way to implement the BlockVisitor interface by only overriding those methods that you are interested in.

Summary

Public Constructors
DefaultBlockVisitor()
Public Methods
void visitBlockEnd(Block block, BlockTarget parent)
Invoked for each Block after all of its properties are visited.
boolean visitBlockStart(Block block, BlockTarget parent)
Invoked for each Block before any of its properties are visited.
boolean visitCompositeProperty(BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)
Invoked for each composite (Block or BlockList) Block Property.
void visitListEnd(BlockList blockList, BlockTarget parent)
Invoked at the end of a BlockList.
boolean visitListStart(BlockList blockList, BlockTarget parent)
Invoked at the beginning of a BlockList.
void visitScalarProperty(BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)
Invoked for each scalar (non-Block, non-BlockList) Block Property.
void visitUnassignedProperty(BlockProperty blockProperty, Block parent)
Invoked for each unassigned block property.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.blocks.BlockVisitor

Public Constructors

public DefaultBlockVisitor ()

Public Methods

public 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 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 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 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 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 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 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.