Package com.microstrategy.web.blocks
Class DefaultBlockVisitor
- java.lang.Object
-
- com.microstrategy.web.blocks.DefaultBlockVisitor
-
- All Implemented Interfaces:
BlockVisitor
- Direct Known Subclasses:
XmlRendererBlockVisitorENF
public class DefaultBlockVisitor extends java.lang.Object implements BlockVisitor
A default implementation of theBlockVisitor
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.- Since:
- MicroStrategy Web 9.0.0
-
-
Constructor Summary
Constructors Constructor Description DefaultBlockVisitor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.
-
-
-
Method Detail
-
visitBlockStart
public boolean visitBlockStart(Block block, BlockTarget parent)
Description copied from interface:BlockVisitor
Invoked for each Block before any of its properties are visited.- Specified by:
visitBlockStart
in interfaceBlockVisitor
- Parameters:
block
- TheBlock
being visited.parent
- TheBlockTarget
that contains the supplied Block.- Returns:
- True if the Block should continue its traversal downward. If false,
then no properties are visited and traversal proceeds to
BlockVisitor.visitBlockEnd(Block, BlockTarget)
.
-
visitBlockEnd
public void visitBlockEnd(Block block, BlockTarget parent)
Description copied from interface:BlockVisitor
Invoked for each Block after all of its properties are visited.- Specified by:
visitBlockEnd
in interfaceBlockVisitor
- Parameters:
block
- TheBlock
being visited.parent
- TheBlockTarget
that contains the supplied Block.
-
visitUnassignedProperty
public void visitUnassignedProperty(BlockProperty blockProperty, Block parent)
Description copied from interface:BlockVisitor
Invoked for each unassigned block property. An "unassigned" BlockProperty is one whose value isnull
.- Specified by:
visitUnassignedProperty
in interfaceBlockVisitor
- Parameters:
blockProperty
- TheBlockProperty
that has an unassigned value.parent
- TheBlock
that contains this BlockProperty.
-
visitScalarProperty
public void visitScalarProperty(BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)
Description copied from interface:BlockVisitor
Invoked for each scalar (non-Block, non-BlockList) Block Property. In particular, it is only invoked for BlockProperty instances whose value is non-null
.- Specified by:
visitScalarProperty
in interfaceBlockVisitor
- Parameters:
blockProperty
- TheBlockProperty
that has an assigned value.parent
- TheBlock
that contains this BlockProperty.firstAssignedProperty
- Whether or not this is the first assigned property of the Block.
-
visitCompositeProperty
public boolean visitCompositeProperty(BlockProperty blockProperty, Block parent, boolean firstAssignedProperty)
Description copied from interface:BlockVisitor
Invoked for each composite (Block or BlockList) Block Property. In particular, it is only invoked for BlockProperty instances whose value is non-null
.- Specified by:
visitCompositeProperty
in interfaceBlockVisitor
- Parameters:
blockProperty
- TheBlockProperty
that has an assigned value.parent
- TheBlock
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.
-
visitListStart
public boolean visitListStart(BlockList blockList, BlockTarget parent)
Description copied from interface:BlockVisitor
Invoked at the beginning of a BlockList.- Specified by:
visitListStart
in interfaceBlockVisitor
- Parameters:
blockList
- TheBlockList
that we are visiting.parent
- TheBlockTarget
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.
-
visitListEnd
public void visitListEnd(BlockList blockList, BlockTarget parent)
Description copied from interface:BlockVisitor
Invoked at the end of a BlockList.- Specified by:
visitListEnd
in interfaceBlockVisitor
- Parameters:
blockList
- TheBlockList
that we are visiting.parent
- TheBlockTarget
that contains the supplied BlockList.
-
-