XmlRendererBlockVisitorANF

Class Overview

This class renders a Block tree in XML format, specifically Attribute Normal Form, where the scalar properties are represented as attributes.

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".
2. The scalar properties are represented as attributes. Scalar-based properties use the name of the BlockProperty as the attribute name and the value of the BlockProperty as the attribute value.
3. Block-based properties use the name of the BlockProperty as the element name. The properties of this child Block become the attributes of it using the rule described above.
4. List-based properties use the name of the BlockProperty as the element name. 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 Fields
From class com.microstrategy.web.blocks.renderers.XmlRendererBlockVisitorENF protected BlockContext blockContext protected XMLBuilder xmlBuilder

[Expand] Inherited Methods
From class com.microstrategy.web.blocks.renderers.XmlRendererBlockVisitorENF String getBlockInListElementName(Block block) Returns the element name to use for a Block in a List. String getDocumentElementName(Block rootBlock) Returns the element name to use for the document element. String getNestedListElementName() Returns the element name to use for a BlockList which appears nested inside another BlockList. String getXML() Gets the XML generated as a String. 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.
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.