XmlRendererBlockVisitorENF

Class Overview

This class renders a Block tree in XML format, specifically Element Normal Form, where the scalar properties are not represented as attributes, but as elements (with the name of the property defining the name of the element). This renderer does not generate any XML attributes whatsoever.

Here are the rules for converting an arbitrary Block tree into an XML structure:

1. The name of the root element is determined by calling the method getDocumentElementName(Block). The default implementation returns "root". The root element has no attributes.
2. Each of the properties defined for the root Block is evaluated in this manner:
   1. Scalar-based properties use the name of the BlockProperty as the element name. A new child element is created and it has a single text node. The value of this text node is the value of the BlockProperty.
   2. Block-based properties use the name of the BlockProperty as the element name (as in the case of scalar-based properties). However, instead of a text node, the properties of this child Block become child elements of this element (using the same rules described above).
   3. List-based properties use the name of the BlockProperty as the element name (as in all cases). However, as the elements of a list have no names (and are only listed one after another), the name of the element that is used for this list element is found by calling getBlockInListElementName(Block). The default implementation returns "block".

Summary

[Expand] Inherited Methods
From class com.microstrategy.web.blocks.DefaultBlockVisitor 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.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.web.blocks.BlockVisitor 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.