public class

WebXMLBuilder

extends XMLStateSerializer
java.lang.Object
   ↳ com.microstrategy.utils.xml.XMLBuilder
     ↳ com.microstrategy.utils.serialization.XMLStateSerializer
       ↳ com.microstrategy.web.objects.WebXMLBuilder
Known Direct Subclasses

Class Overview

This class extends XMLBuilder functionality with services specific for Microstrategy XML format.

Summary

[Expand]
Inherited Fields
From class com.microstrategy.utils.xml.XMLBuilder
Public Constructors
WebXMLBuilder()
Default constructor
WebXMLBuilder(int _bufSize)
Constructs the instance with specified buffer size.
WebXMLBuilder(int _bufSize, boolean _encode)
Constructs the instance with specified buffer size and encoding flag.
WebXMLBuilder(StringBuffer _buf)
Constructs the instance with specified buffer.
WebXMLBuilder(StringBuffer _buf, boolean _encode)
Constructs the instance with specified buffer.
Public Methods
WebXMLBuilder addAttributes(AttrList attrs)
Adds all attributes from the attrs to the current element
WebXMLBuilder addMiInOi(String id, AttrList attrs)
Adds chain of mi, in and oi elements to the current element
WebXMLBuilder addOi(String id, AttrList attrs)
Adds oi child element to the current element
WebXMLBuilder addOiSibling(String id, AttrList attrs)
Adds oi sibleng element to the current element
void addTextOptionToNode(String nodeName, String text)
Add a text node with its parent node's name
final String getId()
Use this method to obtain unique IDs for objects embedded in the XML.
void reset()
Cleanups the buffer and the stack so the builder can be reused for building another XML.
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.XMLStateSerializer
From class com.microstrategy.utils.xml.XMLBuilder
From class java.lang.Object

Public Constructors

public WebXMLBuilder ()

Default constructor

public WebXMLBuilder (int _bufSize)

Constructs the instance with specified buffer size.

Parameters
_bufSize the initial buffer size

public WebXMLBuilder (int _bufSize, boolean _encode)

Constructs the instance with specified buffer size and encoding flag.

Parameters
_bufSize the initial buffer size
_encode flag indicating that XML must be encodded

public WebXMLBuilder (StringBuffer _buf)

Constructs the instance with specified buffer. Used for building embeded objects XML

Parameters
_buf the bufer where to store XML

public WebXMLBuilder (StringBuffer _buf, boolean _encode)

Constructs the instance with specified buffer. Used for building embeded objects XML

Parameters
_buf the bufer where to store XML
_encode flag indicating that XML must be encodded

Public Methods

public WebXMLBuilder addAttributes (AttrList attrs)

Adds all attributes from the attrs to the current element

Parameters
attrs attribute list
Returns
  • this

public WebXMLBuilder addMiInOi (String id, AttrList attrs)

Adds chain of mi, in and oi elements to the current element

Parameters
id a value for the id attribute
attrs other attributes
Returns
  • this

public WebXMLBuilder addOi (String id, AttrList attrs)

Adds oi child element to the current element

Parameters
id a value for the id attribute
attrs other attributes
Returns
  • this

public WebXMLBuilder addOiSibling (String id, AttrList attrs)

Adds oi sibleng element to the current element

Parameters
id a value for the id attribute
attrs other attributes
Returns
  • this

public void addTextOptionToNode (String nodeName, String text)

Add a text node with its parent node's name

Parameters
nodeName parent node name.
text The text for the text node.

public final String getId ()

Use this method to obtain unique IDs for objects embedded in the XML. This IDs are used in id and rfd attributes.

Returns
  • the next ID value

public void reset ()

Cleanups the buffer and the stack so the builder can be reused for building another XML.