org.apache.axiom.om

Interface OMText

All Superinterfaces:

OMInformationItem, OMNode, OMSerializable

All Known Implementing Classes:

CDATASectionImpl, OMTextImpl, TextImpl, TextNodeImpl

public interface OMText
extends OMNode

Represents character data in an XML document. A node of this type is used to represent character data that may appear in element content as well as the prolog and epilog of a document. Note that this node type is used for normal character data, CDATA sections and ignorable whitespace. The OMNode.getType() method may be used to distinguish between these different types of character data.

By default, Axiom uses StAX parsers configured in coalescing mode. As a consequence, CDATA sections will not result in nodes of type OMNode.CDATA_SECTION_NODE nodes, but of type OMNode.TEXT_NODE (See the Javadoc of StAXUtils for information about how to change this behavior). In addition, the object model instance will never contain two adjacent OMText siblings.

The same is not necessarily true for Axiom trees that have been built or updated programmatically or that contain nodes resulting from the expansion of an OMSourcedElement. Therefore, code that manipulates character data MUST NOT assume that text nodes are always coalesced. In particular, when extracting character data from an element, OMElement.getText() should be used instead of getText().

An OMText node stores the character data as String, char[] or a DataHandler. The latter is used for base64 encoded binary data.

Field Summary

Fields inherited from interface org.apache.axiom.om.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentID() Gets the content id.
java.lang.Object	getDataHandler() Gets the datahandler.
OMNamespace	getNamespace() Deprecated. This API is going away. Please use getTextAsQName() instead.
java.lang.String	getText() Returns the text value of this node.
javax.xml.namespace.QName	getTextAsQName() Deprecated. If the underlying parser is non coalescing, then this method may unexpectedly fail or return an incorrect result. Always use OMElement.getTextAsQName() to get the QName value of an element.
char[]	getTextCharacters()
boolean	isBinary()
boolean	isCharacters()
boolean	isOptimized()
void	setBinary(boolean value) Sets the isBinary flag.
void	setContentID(java.lang.String cid) Set a specific content id
void	setOptimize(boolean value) Sets the optimize flag.

Methods inherited from interface org.apache.axiom.om.OMNode

buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

clone, getOMFactory

Method Detail

getText

java.lang.String getText()

Returns the text value of this node.

Returns:

Returns String.

getTextCharacters

char[] getTextCharacters()

isCharacters

boolean isCharacters()

getTextAsQName

javax.xml.namespace.QName getTextAsQName()

Deprecated. If the underlying parser is non coalescing, then this method may unexpectedly fail or return an incorrect result. Always use OMElement.getTextAsQName() to get the QName value of an element.

getNamespace

OMNamespace getNamespace()

Deprecated. This API is going away. Please use getTextAsQName() instead.

Returns the Namespace if this contains a QName Return null otherwise

Returns:

OMNamespace

getDataHandler

java.lang.Object getDataHandler()

Gets the datahandler.

Returns:

Returns datahandler.

isOptimized

boolean isOptimized()

Returns:

Returns boolean flag saying whether the node contains an optimized text or not.

setOptimize

void setOptimize(boolean value)

Sets the optimize flag.

Parameters:

value - true to optimize binary content (usually w/MTOM)

isBinary

boolean isBinary()

Returns:

Returns boolean flag saying whether the node contains binary or not.

setBinary

void setBinary(boolean value)

Sets the isBinary flag.

Parameters:

value - true if the content is binary

getContentID

java.lang.String getContentID()

Gets the content id.

Returns:

Returns String.

setContentID

void setContentID(java.lang.String cid)

Set a specific content id

Parameters:

cid -