Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

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

RWDelta

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

XMLBuilder	addAttribute(String name, int value) A shortcut method to add integer attributes.
XMLBuilder	addAttribute(String name, String value, boolean singleQuot) Adds an attribute to the current element.
final XMLBuilder	addAttribute(String name, String value) Adds an attribute to the current element.
XMLBuilder	addAttributeCond(String name, int value) A shortcut method to add integer attributes.
XMLBuilder	addBoolAttribute(String name, boolean value) A shortcut method to add boolean attributes.
XMLBuilder	addBoolAttribute(String name) A shortcut method to add boolean attributes.
XMLBuilder	addChild(String tagName) Adds a child element to the current element.
XMLBuilder	addChildMixed(String tagName) Adds a child element to the current element.
XMLBuilder	addChildTo(String parentName, String tagName) Adds a child element to the specified element.
XMLBuilder	addRawAttribute(String name, String value, boolean singleQuot) Use this "fast" method instead of `addAttribute(String, String, boolean)` when you are sure that the attribute value does not contain special character '&' and single or double quotes depending on the `singleCode` value.
final XMLBuilder	addRawAttribute(String name, String value) Use this "fast" method instead of `addAttribute(String, String)` when you are sure that the attribute value does not contain special characters '"' and '&'.
XMLBuilder	addRawText(String text) Use this "fast" method instead of `addText` when you are sure that the text does not contain special characters '<', '>', and '&'.
XMLBuilder	addRawTextMixed(String text) Use this "fast" method instead of `addText` when you are sure that the text does not contain special characters '<', '>', and '&'.
XMLBuilder	addRawXML(String text) Use this method to append arbitrary text to the buffer.
XMLBuilder	addRawXML(StringBuffer text)
XMLBuilder	addRequiredBoolAttribute(String name, boolean value) A shortcut method to add a required boolean attributes.
XMLBuilder	addSibling(String tagName) Adds a sibling element to the current element.
XMLBuilder	addSiblingTo(String name, String tagName) Adds a sibling element to the specified element.
XMLBuilder	addText(String text) Adds text to the current element.
XMLBuilder	addTextMixed(String text) Adds text to the current element.
XMLBuilder	addValueTag(String tag, int value) Adds an integer element of format value
XMLBuilder	addValueTag(String tag, float value)
XMLBuilder	addValueTag(String tag, boolean value)
XMLBuilder	addValueTag(String tag, String value) Adds element of format value
XMLBuilder	append(XMLBuilder builder)
XMLBuilder	closeAll() Closes all elements in the stack.
XMLBuilder	closeElement() Closes the current element (adds element closing tag) and removes it from the stack.
XMLBuilder	closeElements(String name, boolean inclusive) Closes all elements in the stack up to the specified element.
void	closeTag()
StringBuffer	getBuffer() Checks if XML building is complete, then returns the XML string buffer.
StringBuffer	getRawBuffer() Returns the XML string buffer in the current state.
StringBuffer	getRawBufferInternal() Check to see if the internal buffer has been allocated.
void	init(StringBuffer _buf) This method is deprecated. use {link `init(String)` instead
void	init(String _buf) Resets the builder and copies the _buf content in the builder's buffer
boolean	isEncode() Returns true if encode flag is true
void	printBuffer() Prints current buffer context (for debugging purposes).
void	reset() Cleanups the buffer and the stack so the builder can be reused for building another XML.
String	toString() Returns the string representation of this object.

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

Throws

XMLBuilderException

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.

Interfaces

Classes

Enums

Exceptions

WebXMLBuilder

Class Overview

Summary

Public Constructors

public WebXMLBuilder ()

public WebXMLBuilder (int _bufSize)

Parameters

public WebXMLBuilder (int _bufSize, boolean _encode)

Parameters

public WebXMLBuilder (StringBuffer _buf)

Parameters

public WebXMLBuilder (StringBuffer _buf, boolean _encode)

Parameters

Public Methods

public WebXMLBuilder addAttributes (AttrList attrs)

Parameters

Returns

Throws

public WebXMLBuilder addMiInOi (String id, AttrList attrs)

Parameters

Returns

public WebXMLBuilder addOi (String id, AttrList attrs)

Parameters

Returns

public WebXMLBuilder addOiSibling (String id, AttrList attrs)

Parameters

Returns

public void addTextOptionToNode (String nodeName, String text)

Parameters

public final String getId ()

Returns

public void reset ()