org.ballerinalang.model.values

Class BXML<T>

java.lang.Object

org.ballerinalang.runtime.message.BallerinaMessageDataSource

org.ballerinalang.model.values.BXML<T>

Type Parameters:

T - Type of the BXML

All Implemented Interfaces:

BCollection, BRefType<T>, BValue, MessageDataSource

Direct Known Subclasses:

BXMLItem, BXMLSequence

public abstract class BXML<T>
extends BallerinaMessageDataSource
implements BRefType<T>, BCollection

BXML represents a XML in Ballerina. An XML could be one of:

• element
• text
• comment
• processing instruction
• sequence of above

Since:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMENT_END End of a XML Comment.
static String	COMMENT_START Start of a XML comment.
static String	PI_END End of a XML processing instruction.
static String	PI_START Start of a XML processing instruction.

Constructor Summary

Constructors

Constructor and Description
BXML()

Method Summary

Modifier and Type	Method and Description
abstract void	addChildren(BXML<?> seq) Add a XMl sequence to this XML as children.
protected void	addDescendants(List<BXML<?>> descendants, org.apache.axiom.om.OMElement currentElement, String qname) Recursively traverse and add the descendant with the given name to the descendants list.
abstract void	build() Builds itself.
abstract BXML<?>	children() Selects and concatenate all the children sequences of the elements in this sequence.
abstract BXML<?>	children(String qname) Selects and concatenate all the children sequences that matches the given qualified name, in all the element-type items in this sequence.
BallerinaMessageDataSource	clone()
abstract BXML<?>	copy() Returns a deep copy of the XML.
abstract BXML<?>	descendants(String qname) Searches in children recursively for elements matching the name and returns a sequence containing them all.
abstract BXML<?>	elements() Get all the elements-type items, in the given sequence.
abstract BXML<?>	elements(String qname) Get all the elements-type items in the given sequence, that matches a given qualified name.
abstract String	getAttribute(String localName, String namespace) Get the value of a single attribute as a string.
abstract String	getAttribute(String localName, String namespace, String prefix) Get the value of a single attribute as a string.
abstract BMap<?,?>	getAttributesMap() Get attributes as a BMap.
abstract BString	getElementName() Get the fully qualified name of the element as a BString.
abstract BXML<?>	getItem(long index) Get an item from the XML sequence, at the given index.
abstract BString	getItemType() Get the type of the XML as a BString.
String	getMessageAsString() Returns the entire message as string.
abstract XMLNodeType	getNodeType() Get the type of the XML.
protected QName	getQname(String qname) Get the QName from BString.
abstract BString	getTextValue() Get the text values in this XML.
BType	getType()
protected static void	handleXmlException(String message, Throwable t)
abstract BBoolean	isEmpty() Check whether the XML sequence is empty.
abstract BBoolean	isSingleton() Check whether the XML sequence contains only a single element.
abstract int	length() Get the length of this XML sequence.
abstract void	removeAttribute(String qname) Remove an attribute from the XML.
abstract void	setAttribute(String localName, String namespace, String prefix, String value) Set the value of a single attribute.
abstract void	setAttributes(BMap<String,?> attributes) Set the attributes of the XMLBMap.
abstract void	setChildren(BXML<?> seq) Set the children of this XML.
abstract BValue	slice(long startIndex, long endIndex) Slice and return a subsequence of the given XML sequence.
abstract BXML<?>	strip() Strips any text items from the XML that are all whitespace.
String	toString()

Methods inherited from class org.ballerinalang.runtime.message.BallerinaMessageDataSource

getContentType, getDataObject, getValue, getValueAsString, getValueAsString, serializeData, setContentType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ballerinalang.model.values.BRefType

value

Methods inherited from interface org.ballerinalang.model.values.BValue

stringValue

Methods inherited from interface org.ballerinalang.model.values.BCollection

newIterator

Field Detail

COMMENT_START

public static final String COMMENT_START

Start of a XML comment.

See Also:

Constant Field Values

COMMENT_END

public static final String COMMENT_END

End of a XML Comment.

See Also:

Constant Field Values

PI_START

public static final String PI_START

Start of a XML processing instruction.

See Also:

Constant Field Values

PI_END

public static final String PI_END

End of a XML processing instruction.

See Also:

Constant Field Values

Constructor Detail

BXML

public BXML()

Method Detail

isEmpty

public abstract BBoolean isEmpty()

Check whether the XML sequence is empty.

Returns:

Flag indicating whether the XML sequence is empty

isSingleton

public abstract BBoolean isSingleton()

Check whether the XML sequence contains only a single element.

Returns:

Flag indicating whether the XML sequence contains only a single element

getItemType

public abstract BString getItemType()

Get the type of the XML as a BString. Type can be one of "element", "text", "comment" or "pi".

Returns:

Type of the XML as a BString

getElementName

public abstract BString getElementName()

Get the fully qualified name of the element as a BString.

Returns:

fully qualified name of the element as a BString.

getTextValue

public abstract BString getTextValue()

Get the text values in this XML.

Returns:

text values in this XML.

getAttribute

public abstract String getAttribute(String localName,
                                    String namespace)

Get the value of a single attribute as a string.

Parameters:

localName - Local name of the attribute

namespace - Namespace of the attribute

Returns:

Value of the attribute

getAttribute

public abstract String getAttribute(String localName,
                                    String namespace,
                                    String prefix)

Get the value of a single attribute as a string.

Parameters:

localName - Local name of the attribute

namespace - Namespace of the attribute

prefix - Prefix of the namespace

Returns:

Value of the attribute

setAttribute

public abstract void setAttribute(String localName,
                                  String namespace,
                                  String prefix,
                                  String value)

Set the value of a single attribute. If the attribute already exsists, then the value will be updated. Otherwise a new attribute will be added.

Parameters:

namespace - Namespace of the attribute

prefix - Namespace prefix of the attribute

localName - Local name of the attribute

value - Value of the attribute

getAttributesMap

public abstract BMap<?,?> getAttributesMap()

Get attributes as a BMap.

Returns:

Attributes as a BMap

setAttributes

public abstract void setAttributes(BMap<String,?> attributes)

Set the attributes of the XMLBMap.

Parameters:

attributes - Attributes to be set.

elements

public abstract BXML<?> elements()

Get all the elements-type items, in the given sequence.

Returns:

All the elements-type items, in the given sequence

elements

public abstract BXML<?> elements(String qname)

Get all the elements-type items in the given sequence, that matches a given qualified name.

Parameters:

qname - qualified name of the element

Returns:

All the elements-type items, that matches a given qualified name, from the this sequence.

children

public abstract BXML<?> children()

Selects and concatenate all the children sequences of the elements in this sequence.

Returns:

All the children sequences of the elements in this sequence

children

public abstract BXML<?> children(String qname)

Selects and concatenate all the children sequences that matches the given qualified name, in all the element-type items in this sequence. Only the children will be selected, but not the nested children.

Parameters:

qname - qualified name of the children to filter

Returns:

All the children that matches the given qualified name, as a sequence

setChildren

public abstract void setChildren(BXML<?> seq)

Set the children of this XML. Any existing children will be removed.

Parameters:

seq - XML Sequence to be set as the children

addChildren

public abstract void addChildren(BXML<?> seq)

Add a XMl sequence to this XML as children.

Parameters:

seq - XML Sequence to be added as the children

strip

public abstract BXML<?> strip()

Strips any text items from the XML that are all whitespace.

Returns:

striped xml

getNodeType

public abstract XMLNodeType getNodeType()

Get the type of the XML.

Returns:

Type of the XML

copy

public abstract BXML<?> copy()

Returns a deep copy of the XML.

Specified by:

copy in interface BValue

Returns:

A copy of this BValue

slice

public abstract BValue slice(long startIndex,
                             long endIndex)

Slice and return a subsequence of the given XML sequence.

Parameters:

startIndex - To slice

endIndex - To slice

Returns:

sliced sequence

descendants

public abstract BXML<?> descendants(String qname)

Searches in children recursively for elements matching the name and returns a sequence containing them all. Does not search within a matched result.

Parameters:

qname - Qualified name of the descendants to filter

Returns:

All the descendants that matches the given qualified name, as a sequence

getItem

public abstract BXML<?> getItem(long index)

Get an item from the XML sequence, at the given index.

Parameters:

index - Index of the item to retrieve

Returns:

Item at the given index in the sequence

length

public abstract int length()

Get the length of this XML sequence.

Returns:

length of this XML sequence.

build

public abstract void build()

Builds itself.

toString

public String toString()

Overrides:

toString in class Object

getType

public BType getType()

Specified by:

getType in interface BValue

getMessageAsString

public String getMessageAsString()

Returns the entire message as string.

Specified by:

getMessageAsString in interface MessageDataSource

Overrides:

getMessageAsString in class BallerinaMessageDataSource

Returns:

message

clone

public BallerinaMessageDataSource clone()

Overrides:

clone in class BallerinaMessageDataSource

handleXmlException

protected static void handleXmlException(String message,
                                         Throwable t)

getQname

protected QName getQname(String qname)

Get the QName from BString.

Parameters:

qname - String representation of qname

Returns:

constructed QName

addDescendants

protected void addDescendants(List<BXML<?>> descendants,
                              org.apache.axiom.om.OMElement currentElement,
                              String qname)

Recursively traverse and add the descendant with the given name to the descendants list.

Parameters:

descendants - List to add descendants

currentElement - Current node

qname - Qualified name of the descendants to search

removeAttribute

public abstract void removeAttribute(String qname)

Remove an attribute from the XML.

Parameters:

qname - Qualified name of the attribute