org.apache.axiom.om.impl.llom

Class OMTextImpl

java.lang.Object

org.apache.axiom.om.impl.llom.OMSerializableImpl

org.apache.axiom.om.impl.llom.OMNodeImpl

org.apache.axiom.om.impl.llom.OMLeafNode

org.apache.axiom.om.impl.llom.OMTextImpl

All Implemented Interfaces:

IChildNode, OMNodeEx, OMConstants, OMInformationItem, OMNode, OMSerializable, OMText

public class OMTextImpl
extends OMLeafNode
implements OMText, OMConstants

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	calcNS
protected char[]	charArray
private java.lang.String	contentID Field contentID for the mime part used when serializing Binary stuff as MTOM optimized.
private java.lang.Object	dataHandlerObject Field dataHandler contains the DataHandler Declaring as Object to remove the dependency on Javax.activation.DataHandler
private static java.lang.String	EMTPY_STRING
protected boolean	isBinary
protected java.lang.String	mimeType
private int	nodeType
protected boolean	optimize
protected OMNamespace	textNS
protected java.lang.String	value
static OMNamespace	XOP_NS Field nameSpace used when serializing Binary stuff as MTOM optimized.

Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

nextSibling, parent, previousSibling

Fields inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

factory

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

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

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

Constructors

Constructor and Description
OMTextImpl(java.lang.Object dataHandler, OMFactory factory)
OMTextImpl(OMContainer parent, char[] charArray, int nodeType, OMFactory factory)
OMTextImpl(OMContainer parent, java.lang.Object dataHandler, boolean optimize, OMFactory factory, boolean fromBuilder)
OMTextImpl(OMContainer parent, OMTextImpl source, OMFactory factory) Construct OMTextImpl that is a copy of the source OMTextImpl
OMTextImpl(OMContainer parent, javax.xml.namespace.QName text, int nodeType, OMFactory factory)
OMTextImpl(OMContainer parent, javax.xml.namespace.QName text, OMFactory factory)
OMTextImpl(OMContainer parent, java.lang.String text, int nodeType, OMFactory factory, boolean fromBuilder)
OMTextImpl(OMContainer parent, java.lang.String text, OMFactory factory) Constructor OMTextImpl.
OMTextImpl(OMContainer parent, java.lang.String s, java.lang.String mimeType, boolean optimize, OMFactory factory)
OMTextImpl(java.lang.String contentID, DataHandlerProvider dataHandlerProvider, boolean optimize, OMFactory factory) Constructor.
OMTextImpl(java.lang.String s, int nodeType, OMFactory factory)
OMTextImpl(java.lang.String s, OMFactory factory) Constructor OMTextImpl.
OMTextImpl(java.lang.String s, java.lang.String mimeType, boolean optimize, OMFactory factory)

Method Summary

Modifier and Type	Method and Description
void	buildWithAttachments() Parses this node and builds the object structure in memory.
(package private) OMNode	clone(OMCloneOptions options, OMContainer targetParent)
java.lang.String	getContentID() Gets the content id.
java.lang.Object	getDataHandler() Gets the datahandler.
OMNamespace	getNamespace() Returns the Namespace if this contains a QName Return null otherwise
java.lang.String	getText() Returns the value.
javax.xml.namespace.QName	getTextAsQName() Returns the value.
char[]	getTextCharacters()
private java.lang.String	getTextFromProperPlace() This OMText contains two data source:value and charArray.
int	getType() Returns the type of node.
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache) Serializes the node.
boolean	isBinary()
boolean	isCharacters()
boolean	isOptimized()
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.
private void	writeOutput(javax.xml.stream.XMLStreamWriter writer) Writes the relevant output.

Methods inherited from class org.apache.axiom.om.impl.llom.OMLeafNode

build, discard, getBuilder, isComplete, setComplete

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

clone, detach, getIParentNode, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

close, getOMFactory, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from class java.lang.Object

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

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

detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, 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

Field Detail

XOP_NS

public static final OMNamespace XOP_NS

Field nameSpace used when serializing Binary stuff as MTOM optimized.

nodeType

private int nodeType

value

protected java.lang.String value

charArray

protected char[] charArray

calcNS

private boolean calcNS

textNS

protected OMNamespace textNS

mimeType

protected java.lang.String mimeType

optimize

protected boolean optimize

isBinary

protected boolean isBinary

contentID

private java.lang.String contentID

Field contentID for the mime part used when serializing Binary stuff as MTOM optimized.

dataHandlerObject

private java.lang.Object dataHandlerObject

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

EMTPY_STRING

private static final java.lang.String EMTPY_STRING

See Also:

Constant Field Values

Constructor Detail

OMTextImpl

public OMTextImpl(java.lang.String s,
                  OMFactory factory)

Constructor OMTextImpl.

Parameters:

s -

OMTextImpl

public OMTextImpl(java.lang.String s,
                  int nodeType,
                  OMFactory factory)

Parameters:

s -

nodeType - - OMText can handle CHARACTERS, SPACES, CDATA and ENTITY REFERENCES. Constants for this can be found in OMNode.

OMTextImpl

public OMTextImpl(OMContainer parent,
                  java.lang.String text,
                  OMFactory factory)

Constructor OMTextImpl.

Parameters:

parent -

text -

OMTextImpl

public OMTextImpl(OMContainer parent,
                  OMTextImpl source,
                  OMFactory factory)

Construct OMTextImpl that is a copy of the source OMTextImpl

Parameters:

parent -

source - OMTextImpl

factory -

OMTextImpl

public OMTextImpl(OMContainer parent,
                  java.lang.String text,
                  int nodeType,
                  OMFactory factory,
                  boolean fromBuilder)

OMTextImpl

public OMTextImpl(OMContainer parent,
                  char[] charArray,
                  int nodeType,
                  OMFactory factory)

OMTextImpl

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

OMTextImpl

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

OMTextImpl

public OMTextImpl(java.lang.String s,
                  java.lang.String mimeType,
                  boolean optimize,
                  OMFactory factory)

Parameters:

s - - base64 encoded String representation of Binary

mimeType - of the Binary

OMTextImpl

public OMTextImpl(OMContainer parent,
                  java.lang.String s,
                  java.lang.String mimeType,
                  boolean optimize,
                  OMFactory factory)

Parameters:

parent -

s - - base64 encoded String representation of Binary

mimeType - of the Binary

OMTextImpl

public OMTextImpl(java.lang.Object dataHandler,
                  OMFactory factory)

Parameters:

dataHandler - To send binary optimised content Created programatically.

OMTextImpl

public OMTextImpl(OMContainer parent,
                  java.lang.Object dataHandler,
                  boolean optimize,
                  OMFactory factory,
                  boolean fromBuilder)

Parameters:

dataHandler -

optimize - To send binary content. Created progrmatically.

OMTextImpl

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

Constructor.

Parameters:

dataHandlerProvider -

optimize -

factory -

Method Detail

getType

public final int getType()

Description copied from interface: OMNode

Returns the type of node.

Specified by:

getType in interface OMNode

Returns:

Returns one of OMNode.ELEMENT_NODE, OMNode.TEXT_NODE, OMNode.CDATA_SECTION_NODE, OMNode.COMMENT_NODE, OMNode.DTD_NODE, OMNode.PI_NODE, OMNode.ENTITY_REFERENCE_NODE or OMNode.SPACE_NODE.

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()
                         throws OMException

Returns the value.

Specified by:

getText in interface OMText

Returns:

Returns String.

Throws:

OMException

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()

This OMText contains two data source:value and charArray. This method will return text from correct place.

getTextAsQName

public javax.xml.namespace.QName getTextAsQName()
                                         throws OMException

Returns the value.

Specified by:

getTextAsQName in interface OMText

Throws:

OMException

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

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)

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

isBinary

public boolean isBinary()

Specified by:

isBinary in interface OMText

Returns:

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

getDataHandler

public java.lang.Object getDataHandler()

Gets the datahandler.

Specified by:

getDataHandler in interface OMText

Returns:

Returns javax.activation.DataHandler

getContentID

public java.lang.String getContentID()

Description copied from interface: OMText

Gets the content id.

Specified by:

getContentID in interface OMText

Returns:

Returns String.

internalSerialize

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

Description copied from class: OMSerializableImpl

Serializes the node.

Specified by:

internalSerialize in interface OMNodeEx

Specified by:

internalSerialize in class OMSerializableImpl

cache - indicates if caching should be enabled

Throws:

javax.xml.stream.XMLStreamException

buildWithAttachments

public void buildWithAttachments()

Description copied from class: OMNodeImpl

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 OMNodeImpl

setContentID

public void setContentID(java.lang.String cid)

Description copied from interface: OMText

Set a specific content id

Specified by:

setContentID in interface OMText

clone

OMNode clone(OMCloneOptions options,
             OMContainer targetParent)

Specified by:

clone in class OMNodeImpl