org.xins.common.xml

Class DataElementBuilder

java.lang.Object

org.xins.common.xml.DataElementBuilder

public class DataElementBuilder
extends Object

Class used to create a XINS data section.

Since:

XINS 3.0

Author:

Anthony Goubard

Constructor Summary

Constructors

Constructor and Description
DataElementBuilder() Creates a new data element.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToDataElement(Element subElement) Adds an element to the data section.
Element	addToDataElement(String elementName) Adds an element to the data section.
Element	createElement(String elementName) Creates a new element intented to be included in the data section.
Element	getDataElement() Gets the data element.
Document	getDocument() Gets the document used to create the data section.
String	toString() Creates the String representation of the data section.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataElementBuilder

public DataElementBuilder()

Creates a new data element.

Method Detail

createElement

public Element createElement(String elementName)

Creates a new element intented to be included in the data section.

Parameters:

elementName - the name of the element, cannot be null.

Returns:

the created element, never null.

addToDataElement

public void addToDataElement(Element subElement)

Adds an element to the data section. The added element is a direct child of the data element.

Parameters:

subElement - the element to add, cannot be null.

addToDataElement

public Element addToDataElement(String elementName)

Adds an element to the data section. The empty element based on the element name is created before being added. The added element is a direct child of the data element.

Parameters:

elementName - the name of the element to add, cannot be null.

Returns:

the created element, never null

getDocument

public Document getDocument()

Gets the document used to create the data section.

Returns:

the DOM document, never null.

getDataElement

public Element getDataElement()

Gets the data element.

Returns:

the data element, never null.

toString

public String toString()

Creates the String representation of the data section.

Overrides:

toString in class Object

Returns:

the XML as String without XML declaration, never null.