org.ballerinalang.model.values

Class BXMLItem

java.lang.Object

org.ballerinalang.runtime.message.BallerinaMessageDataSource

org.ballerinalang.model.values.BXML<org.apache.axiom.om.OMNode>

org.ballerinalang.model.values.BXMLItem

All Implemented Interfaces:

BCollection, BRefType<org.apache.axiom.om.OMNode>, BValue, MessageDataSource

public final class BXMLItem
extends BXML<org.apache.axiom.om.OMNode>

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

• element
• text
• comment
• processing instruction

Since:

0.88

Field Summary

Fields inherited from class org.ballerinalang.model.values.BXML

COMMENT_END, COMMENT_START, PI_END, PI_START

Constructor Summary

Constructors

Constructor and Description
BXMLItem() Create an empty XMLValue.
BXMLItem(InputStream inputStream) Create a BXMLItem from a InputStream.
BXMLItem(org.apache.axiom.om.OMNode value) Initialize a BXMLItem from a OMNode object.
BXMLItem(String xmlValue) Initialize a BXMLItem from a XML string.

Method Summary

Modifier and Type	Method and Description
void	addChildren(BXML<?> seq) Add a XMl sequence to this XML as children.
void	build() Builds itself.
BXML<?>	children() Selects and concatenate all the children sequences of the elements in this sequence.
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.
BXMLItem	copy() Returns a deep copy of the XML.
BXML<?>	descendants(String qname) Searches in children recursively for elements matching the name and returns a sequence containing them all.
BXML<?>	elements() Get all the elements-type items, in the given sequence.
BXML<?>	elements(String qname) Get all the elements-type items in the given sequence, that matches a given qualified name.
String	getAttribute(String localName, String namespace) Get the value of a single attribute as a string.
String	getAttribute(String localName, String namespace, String prefix) Get the value of a single attribute as a string.
BMap<?,?>	getAttributesMap() Get attributes as a BMap.
BString	getElementName() Get the fully qualified name of the element as a BString.
BXML<?>	getItem(long index) Get an item from the XML sequence, at the given index.
BString	getItemType() Get the type of the XML as a BString.
XMLNodeType	getNodeType() Get the type of the XML.
BString	getTextValue() Get the text values in this XML.
BBoolean	isEmpty() Check whether the XML sequence is empty.
BBoolean	isSingleton() Check whether the XML sequence contains only a single element.
int	length() Get the length of this XML sequence.
BIterator	newIterator() Create new Iterator for this collection.
void	removeAttribute(String qname) Remove an attribute from the XML.
void	serializeData(OutputStream outputStream) Serialize data in to a byte stream.
void	setAttribute(String localName, String namespaceUri, String prefix, String value) Set the value of a single attribute.
void	setAttributes(BMap<String,?> attributes) Set the attributes of the XMLBMap.
void	setChildren(BXML<?> seq) Set the children of this XML.
BXML<?>	slice(long startIndex, long endIndex) Slice and return a subsequence of the given XML sequence.
String	stringValue()
BXML<?>	strip() Strips any text items from the XML that are all whitespace.
org.apache.axiom.om.OMNode	value()

Methods inherited from class org.ballerinalang.model.values.BXML

addDescendants, clone, getMessageAsString, getQname, getType, handleXmlException, toString

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

getContentType, getDataObject, getValue, getValueAsString, getValueAsString, setContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

BXMLItem

public BXMLItem()

Create an empty XMLValue.

BXMLItem

public BXMLItem(String xmlValue)

Initialize a BXMLItem from a XML string.

Parameters:

xmlValue - A XML string

BXMLItem

public BXMLItem(org.apache.axiom.om.OMNode value)

Initialize a BXMLItem from a OMNode object.

Parameters:

value - xml object

BXMLItem

public BXMLItem(InputStream inputStream)

Create a BXMLItem from a InputStream.

Parameters:

inputStream - Input Stream

Method Detail

getNodeType

public XMLNodeType getNodeType()

Get the type of the XML.

Specified by:

getNodeType in class BXML<org.apache.axiom.om.OMNode>

Returns:

Type of the XML

isEmpty

public BBoolean isEmpty()

Check whether the XML sequence is empty.

Specified by:

isEmpty in class BXML<org.apache.axiom.om.OMNode>

Returns:

Flag indicating whether the XML sequence is empty

isSingleton

public BBoolean isSingleton()

Check whether the XML sequence contains only a single element.

Specified by:

isSingleton in class BXML<org.apache.axiom.om.OMNode>

Returns:

Flag indicating whether the XML sequence contains only a single element

getItemType

public BString getItemType()

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

Specified by:

getItemType in class BXML<org.apache.axiom.om.OMNode>

Returns:

Type of the XML as a BString

getElementName

public BString getElementName()

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

Specified by:

getElementName in class BXML<org.apache.axiom.om.OMNode>

Returns:

fully qualified name of the element as a BString.

getTextValue

public BString getTextValue()

Get the text values in this XML.

Specified by:

getTextValue in class BXML<org.apache.axiom.om.OMNode>

Returns:

text values in this XML.

getAttribute

public String getAttribute(String localName,
                           String namespace)

Get the value of a single attribute as a string.

Specified by:

getAttribute in class BXML<org.apache.axiom.om.OMNode>

Parameters:

localName - Local name of the attribute

namespace - Namespace of the attribute

Returns:

Value of the attribute

getAttribute

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

Get the value of a single attribute as a string.

Specified by:

getAttribute in class BXML<org.apache.axiom.om.OMNode>

Parameters:

localName - Local name of the attribute

namespace - Namespace of the attribute

prefix - Prefix of the namespace

Returns:

Value of the attribute

setAttribute

public void setAttribute(String localName,
                         String namespaceUri,
                         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.

Specified by:

setAttribute in class BXML<org.apache.axiom.om.OMNode>

Parameters:

localName - Local name of the attribute

namespaceUri - Namespace of the attribute

prefix - Namespace prefix of the attribute

value - Value of the attribute

getAttributesMap

public BMap<?,?> getAttributesMap()

Get attributes as a BMap.

Specified by:

getAttributesMap in class BXML<org.apache.axiom.om.OMNode>

Returns:

Attributes as a BMap

setAttributes

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

Set the attributes of the XMLBMap.

Specified by:

setAttributes in class BXML<org.apache.axiom.om.OMNode>

Parameters:

attributes - Attributes to be set.

elements

public BXML<?> elements()

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

Specified by:

elements in class BXML<org.apache.axiom.om.OMNode>

Returns:

All the elements-type items, in the given sequence

elements

public BXML<?> elements(String qname)

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

Specified by:

elements in class BXML<org.apache.axiom.om.OMNode>

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 BXML<?> children()

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

Specified by:

children in class BXML<org.apache.axiom.om.OMNode>

Returns:

All the children sequences of the elements in this sequence

children

public 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.

Specified by:

children in class BXML<org.apache.axiom.om.OMNode>

Parameters:

qname - qualified name of the children to filter

Returns:

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

setChildren

public void setChildren(BXML<?> seq)

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

Specified by:

setChildren in class BXML<org.apache.axiom.om.OMNode>

Parameters:

seq - XML Sequence to be set as the children

addChildren

public void addChildren(BXML<?> seq)

Add a XMl sequence to this XML as children.

Specified by:

addChildren in class BXML<org.apache.axiom.om.OMNode>

Parameters:

seq - XML Sequence to be added as the children

strip

public BXML<?> strip()

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

Specified by:

strip in class BXML<org.apache.axiom.om.OMNode>

Returns:

striped xml

slice

public BXML<?> slice(long startIndex,
                     long endIndex)

Slice and return a subsequence of the given XML sequence.

Specified by:

slice in class BXML<org.apache.axiom.om.OMNode>

Parameters:

startIndex - To slice

endIndex - To slice

Returns:

sliced sequence

descendants

public 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.

Specified by:

descendants in class BXML<org.apache.axiom.om.OMNode>

Parameters:

qname - Qualified name of the descendants to filter

Returns:

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

serializeData

public void serializeData(OutputStream outputStream)

Serialize data in to a byte stream.

Specified by:

serializeData in interface MessageDataSource

Overrides:

serializeData in class BallerinaMessageDataSource

value

public org.apache.axiom.om.OMNode value()

stringValue

public String stringValue()

copy

public BXMLItem copy()

Returns a deep copy of the XML.

Specified by:

copy in interface BValue

Specified by:

copy in class BXML<org.apache.axiom.om.OMNode>

Returns:

A copy of this BValue

getItem

public BXML<?> getItem(long index)

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

Specified by:

getItem in class BXML<org.apache.axiom.om.OMNode>

Parameters:

index - Index of the item to retrieve

Returns:

Item at the given index in the sequence

length

public int length()

Get the length of this XML sequence.

Specified by:

length in class BXML<org.apache.axiom.om.OMNode>

Returns:

length of this XML sequence.

build

public void build()

Builds itself.

Specified by:

build in class BXML<org.apache.axiom.om.OMNode>

removeAttribute

public void removeAttribute(String qname)

Remove an attribute from the XML.

Specified by:

removeAttribute in class BXML<org.apache.axiom.om.OMNode>

Parameters:

qname - Qualified name of the attribute

newIterator

public BIterator newIterator()

Description copied from interface: BCollection

Create new Iterator for this collection.

Returns:

iterator created.