org.apache.axiom.om.impl.dom

Class TextNodeImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.LeafNode

org.apache.axiom.om.impl.dom.CharacterImpl

org.apache.axiom.om.impl.dom.TextNodeImpl

All Implemented Interfaces:

IChildNode, OMNodeEx, OMInformationItem, OMNode, OMSerializable, OMText, org.w3c.dom.CharacterData, org.w3c.dom.Node, org.w3c.dom.Text

Direct Known Subclasses:

CDATASectionImpl, TextImpl

public abstract class TextNodeImpl
extends CharacterImpl
implements org.w3c.dom.Text, OMText

Field Summary

Fields

Modifier and Type	Field and Description
protected char[]	charArray
private java.lang.String	contentID
private java.lang.Object	dataHandlerObject Field dataHandler contains the DataHandler.
private boolean	isBinary
private java.lang.String	mimeType
private boolean	optimize
protected OMNamespace	textNS

Fields inherited from class org.apache.axiom.om.impl.dom.CharacterImpl

textValue

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

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

Constructor Summary

Constructors

Constructor and Description
TextNodeImpl(char[] value, OMFactory factory)
TextNodeImpl(java.lang.Object dataHandler, boolean optimize, OMFactory factory)
TextNodeImpl(OMContainer parent, javax.xml.namespace.QName text, int nodeType, OMFactory factory)
TextNodeImpl(OMContainer parent, javax.xml.namespace.QName text, OMFactory factory)
TextNodeImpl(OMFactory factory)
TextNodeImpl(java.lang.String contentID, DataHandlerProvider dataHandlerProvider, boolean optimize, OMFactory factory) Constructor.
TextNodeImpl(java.lang.String text, OMFactory factory) Creates a text node with the given text required by the OMDOMFactory.
TextNodeImpl(java.lang.String text, java.lang.String mimeType, boolean optimize, boolean isBinary, OMFactory factory)
TextNodeImpl(java.lang.String text, java.lang.String mimeType, boolean optimize, OMFactory factory)
TextNodeImpl(TextNodeImpl source, OMFactory factory) Construct TextImpl that is a copy of the source OMTextImpl

Method Summary

Modifier and Type	Method and Description
(package private) void	beforeClone(OMCloneOptions options)
void	buildWithAttachments() Parses this node and builds the object structure in memory.
java.lang.String	getContentID() Gets the content id.
java.lang.String	getData() Returns the value of the data.
java.lang.Object	getDataHandler() Gets the datahandler.
OMNamespace	getNamespace() Returns the Namespace if this contains a QName Return null otherwise
java.lang.String	getNodeName()
short	getNodeType()
java.lang.String	getNodeValue()
java.lang.String	getText() Returns the text value of this node.
javax.xml.namespace.QName	getTextAsQName()
char[]	getTextCharacters()
private java.lang.String	getTextFromProperPlace()
private java.lang.String	getTextString()
java.lang.String	getWholeText()
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache) Serializes the node.
boolean	isBinary()
boolean	isCharacters()
boolean	isElementContentWhitespace()
boolean	isOptimized()
org.w3c.dom.Text	replaceWholeText(java.lang.String content)
void	setBinary(boolean value) Receiving binary can happen as either MTOM attachments or as Base64 Text In the case of Base64 user has to explicitly specify that the content is binary, before calling getDataHandler(), getInputStream()....
void	setContentID(java.lang.String cid) Set a specific content id
void	setOptimize(boolean value) Sets the optimize flag.
org.w3c.dom.Text	splitText(int offset) Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
java.lang.String	toString()
private void	writeOutput(javax.xml.stream.XMLStreamWriter writer) Writes the relevant output.

Methods inherited from class org.apache.axiom.om.impl.dom.CharacterImpl

appendData, deleteData, getLength, insertData, replaceData, setData, substringData

Methods inherited from class org.apache.axiom.om.impl.dom.LeafNode

appendChild, build, clone, createClone, discard, getBuilder, getChildNodes, getIParentNode, getNextOMSibling, getNextSibling, insertBefore, internalGetNextSibling, internalGetOwnerNode, internalGetPreviousSibling, internalSetNextSibling, internalSetOwnerNode, internalSetPreviousSibling, isComplete, lookupNamespaceURI, removeChild, replaceChild, setComplete

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

checkSameOwnerDocument, clone, cloneNode, close, compareDocumentPosition, detach, detach, getAttributes, getBaseURI, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextOMSiblingIfAvailable, getOMFactory, getOwnerDocument, getParent, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getTextContent, getTextContent, getUserData, hasAttributes, hasChildNodes, hasParent, hasParent, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isFirstChild, isFirstChild, isSameNode, isSpecified, isSpecified, isSupported, lookupPrefix, normalize, normalize, ownerDocument, parentNode, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setOwnerDocument, setParent, setParent, setPrefix, setPreviousOMSibling, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.CharacterData

appendData, deleteData, getLength, insertData, replaceData, setData, substringData

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

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

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

Methods inherited from interface org.apache.axiom.om.impl.OMNodeEx

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling

Field Detail

mimeType

private java.lang.String mimeType

optimize

private boolean optimize

isBinary

private boolean isBinary

contentID

private java.lang.String contentID

textNS

protected OMNamespace textNS

charArray

protected char[] charArray

dataHandlerObject

private java.lang.Object dataHandlerObject

Field dataHandler contains the DataHandler. Declaring as Object to remove the dependency on Javax.activation.DataHandler

Constructor Detail

TextNodeImpl

public TextNodeImpl(java.lang.String text,
                    OMFactory factory)

Creates a text node with the given text required by the OMDOMFactory. The owner document should be set properly when appending this to a DOM tree.

Parameters:

text -

TextNodeImpl

public TextNodeImpl(TextNodeImpl source,
                    OMFactory factory)

Construct TextImpl that is a copy of the source OMTextImpl

Parameters:

parent -

source - TextImpl

factory -

TextNodeImpl

public TextNodeImpl(java.lang.String text,
                    java.lang.String mimeType,
                    boolean optimize,
                    OMFactory factory)

TextNodeImpl

public TextNodeImpl(java.lang.String text,
                    java.lang.String mimeType,
                    boolean optimize,
                    boolean isBinary,
                    OMFactory factory)

TextNodeImpl

public TextNodeImpl(java.lang.Object dataHandler,
                    boolean optimize,
                    OMFactory factory)

Parameters:

dataHandler -

optimize - To send binary content. Created progrmatically.

TextNodeImpl

public TextNodeImpl(java.lang.String contentID,
                    DataHandlerProvider dataHandlerProvider,
                    boolean optimize,
                    OMFactory factory)

Constructor.

Parameters:

contentID -

dataHandlerProvider -

optimize -

factory -

TextNodeImpl

public TextNodeImpl(OMFactory factory)

Parameters:

ownerNode -

TextNodeImpl

public TextNodeImpl(char[] value,
                    OMFactory factory)

TextNodeImpl

public TextNodeImpl(OMContainer parent,
                    javax.xml.namespace.QName text,
                    OMFactory factory)

TextNodeImpl

public TextNodeImpl(OMContainer parent,
                    javax.xml.namespace.QName text,
                    int nodeType,
                    OMFactory factory)

Method Detail

splitText

public org.w3c.dom.Text splitText(int offset)
                           throws org.w3c.dom.DOMException

Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

Specified by:

splitText in interface org.w3c.dom.Text

Throws:

org.w3c.dom.DOMException

getNodeName

public java.lang.String getNodeName()

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface org.w3c.dom.Node

isOptimized

public boolean isOptimized()

Specified by:

isOptimized in interface OMText

Returns:

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

setOptimize

public void setOptimize(boolean value)

Description copied from interface: OMText

Sets the optimize flag.

Specified by:

setOptimize in interface OMText

Parameters:

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

writeOutput

private void writeOutput(javax.xml.stream.XMLStreamWriter writer)
                  throws javax.xml.stream.XMLStreamException

Writes the relevant output.

Parameters:

writer -

Throws:

javax.xml.stream.XMLStreamException

getText

public java.lang.String getText()

Description copied from interface: OMText

Returns the text value of this node.

Specified by:

getText in interface OMText

Returns:

Returns String.

getData

public java.lang.String getData()
                         throws org.w3c.dom.DOMException

Description copied from class: CharacterImpl

Returns the value of the data.

Specified by:

getData in interface org.w3c.dom.CharacterData

Overrides:

getData in class CharacterImpl

Throws:

org.w3c.dom.DOMException

getTextCharacters

public char[] getTextCharacters()

Specified by:

getTextCharacters in interface OMText

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface OMText

getTextFromProperPlace

private java.lang.String getTextFromProperPlace()

getTextString

private java.lang.String getTextString()

getTextAsQName

public javax.xml.namespace.QName getTextAsQName()

Specified by:

getTextAsQName in interface OMText

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

Specified by:

getNodeValue in interface org.w3c.dom.Node

Overrides:

getNodeValue in class NodeImpl

Throws:

org.w3c.dom.DOMException

getContentID

public java.lang.String getContentID()

Description copied from interface: OMText

Gets the content id.

Specified by:

getContentID in interface OMText

Returns:

Returns String.

getDataHandler

public java.lang.Object getDataHandler()

Description copied from interface: OMText

Gets the datahandler.

Specified by:

getDataHandler in interface OMText

Returns:

Returns datahandler.

internalSerialize

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer,
                              boolean cache)
                       throws javax.xml.stream.XMLStreamException

Description copied from interface: OMNodeEx

Serializes the node. Note that this is an internal method that MUST NOT be used outside of Axiom. Please use OMSerializable.serialize(XMLStreamWriter, boolean) instead.

Specified by:

internalSerialize in interface OMNodeEx

Specified by:

internalSerialize in class NodeImpl

cache - indicates if caching should be enabled

Throws:

javax.xml.stream.XMLStreamException

getWholeText

public java.lang.String getWholeText()

Specified by:

getWholeText in interface org.w3c.dom.Text

isElementContentWhitespace

public boolean isElementContentWhitespace()

Specified by:

isElementContentWhitespace in interface org.w3c.dom.Text

replaceWholeText

public org.w3c.dom.Text replaceWholeText(java.lang.String content)
                                  throws org.w3c.dom.DOMException

Specified by:

replaceWholeText in interface org.w3c.dom.Text

Throws:

org.w3c.dom.DOMException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

buildWithAttachments

public void buildWithAttachments()

Description copied from class: NodeImpl

Parses this node and builds the object structure in memory. AXIOM supports two levels of deffered building. First is deffered building of AXIOM using StAX. Second level is the deffered building of attachments. AXIOM reads in the attachements from the stream only when user asks by calling getDataHandler(). build() method builds the OM without the attachments. buildAll() builds the OM together with attachement data. This becomes handy when user wants to free the input stream.

Specified by:

buildWithAttachments in interface OMNode

Overrides:

buildWithAttachments in class NodeImpl

isBinary

public boolean isBinary()

Specified by:

isBinary in interface OMText

Returns:

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

setBinary

public void setBinary(boolean value)

Receiving binary can happen as either MTOM attachments or as Base64 Text In the case of Base64 user has to explicitly specify that the content is binary, before calling getDataHandler(), getInputStream()....

Specified by:

setBinary in interface OMText

Parameters:

value - true if the content is binary

getNamespace

public OMNamespace getNamespace()

Description copied from interface: OMText

Returns the Namespace if this contains a QName Return null otherwise

Specified by:

getNamespace in interface OMText

Returns:

OMNamespace

setContentID

public void setContentID(java.lang.String cid)

Description copied from interface: OMText

Set a specific content id

Specified by:

setContentID in interface OMText

beforeClone

void beforeClone(OMCloneOptions options)

Overrides:

beforeClone in class LeafNode