org.apache.axiom.om.impl.dom.factory

Class OMDOMFactory

java.lang.Object

org.apache.axiom.om.impl.dom.factory.OMDOMFactory

All Implemented Interfaces:

OMFactoryEx, OMFactory

Direct Known Subclasses:

DOMSOAPFactory

public class OMDOMFactory
extends java.lang.Object
implements OMFactoryEx

OM factory implementation for DOOM. It creates nodes that implement DOM as defined by the interfaces in org.w3c.dom.

Field Summary

Fields

Modifier and Type	Field and Description
private OMDOMMetaFactory	metaFactory

Constructor Summary

Constructors

Constructor and Description
OMDOMFactory()
OMDOMFactory(OMDOMMetaFactory metaFactory)

Method Summary

Modifier and Type	Method and Description
OMAttribute	createOMAttribute(java.lang.String localName, OMNamespace ns, java.lang.String value) Create an attribute with the given name and value.
OMComment	createOMComment(OMContainer parent, java.lang.String content) Creates a comment.
OMComment	createOMComment(OMContainer parent, java.lang.String content, boolean fromBuilder)
OMDocType	createOMDocType(OMContainer parent, java.lang.String rootName, java.lang.String publicId, java.lang.String systemId, java.lang.String internalSubset) Creates DTD (DOCTYPE declaration) node.
OMDocType	createOMDocType(OMContainer parent, java.lang.String rootName, java.lang.String publicId, java.lang.String systemId, java.lang.String internalSubset, boolean fromBuilder)
OMDocument	createOMDocument() Creates a new OMDocument.
OMDocument	createOMDocument(OMXMLParserWrapper builder)
OMSourcedElement	createOMElement(OMDataSource source) Create a sourced element.
OMSourcedElement	createOMElement(OMDataSource source, javax.xml.namespace.QName qname) Unsupported.
OMSourcedElement	createOMElement(OMDataSource source, java.lang.String localName, OMNamespace ns) Create a sourced element with a known local name and namespace URI.
OMElement	createOMElement(OMDataSource source, java.lang.String localName, OMNamespace ns, OMContainer parent)
OMElement	createOMElement(javax.xml.namespace.QName qname) Create an OMElement with the given QName If the QName contains a prefix, we will ensure that an OMNamespace is created mapping the given namespace to the given prefix.
OMElement	createOMElement(javax.xml.namespace.QName qname, OMContainer parent) Creates a new OMDOM Element node and adds it to the given parent.
OMElement	createOMElement(java.lang.String localName, OMContainer parent, OMXMLParserWrapper builder) Creates an OMElement with the builder.
OMElement	createOMElement(java.lang.String localName, OMNamespace ns) Create an element with the given name.
OMElement	createOMElement(java.lang.String localName, OMNamespace ns, OMContainer parent) Create an element with the given name and parent.
OMElement	createOMElement(java.lang.String localName, java.lang.String namespaceURI, java.lang.String prefix) Create an element with the given name.
OMEntityReference	createOMEntityReference(OMContainer parent, java.lang.String name) Create an entity reference.
OMEntityReference	createOMEntityReference(OMContainer parent, java.lang.String name, java.lang.String replacementText, boolean fromBuilder)
OMNamespace	createOMNamespace(java.lang.String uri, java.lang.String prefix) Creates a new OMNamespace.
OMProcessingInstruction	createOMProcessingInstruction(OMContainer parent, java.lang.String piTarget, java.lang.String piData) Creates a PI.
OMProcessingInstruction	createOMProcessingInstruction(OMContainer parent, java.lang.String piTarget, java.lang.String piData, boolean fromBuilder)
OMText	createOMText(java.lang.Object dataHandler, boolean optimize) Creates a new OMDOM Text node with the given datahandler and the given MTOM optimization configuration and returns it.
OMText	createOMText(OMContainer parent, char[] charArary, int type)
OMText	createOMText(OMContainer parent, java.lang.Object dataHandler, boolean optimize, boolean fromBuilder)
OMText	createOMText(OMContainer parent, OMText source) Create OMText node that is a copy of the source text node
OMText	createOMText(OMContainer parent, javax.xml.namespace.QName text)
OMText	createOMText(OMContainer parent, javax.xml.namespace.QName text, int type)
OMText	createOMText(OMContainer parent, java.lang.String text) Creates a new OMText node with the given value and appends it to the given parent element.
OMText	createOMText(OMContainer parent, java.lang.String text, int type)
OMText	createOMText(OMContainer parent, java.lang.String text, int type, boolean fromBuilder)
OMText	createOMText(OMContainer parent, java.lang.String s, java.lang.String mimeType, boolean optimize) Creates an OMDOM Text node, adds it to the give parent element and returns it.
OMText	createOMText(java.lang.String s) Creates a OMDOM Text node carrying the given value.
OMText	createOMText(java.lang.String contentID, DataHandlerProvider dataHandlerProvider, boolean optimize) Create a binary OMText node supporting deferred loading of the content.
OMText	createOMText(java.lang.String text, int type) Creates a Character node of the given type.
OMText	createOMText(java.lang.String text, java.lang.String mimeType, boolean optimize) Creates a new OMDOM Text node with the value of the given text value along with the MTOM optimization parameters and returns it.
OMMetaFactory	getMetaFactory() Get the OMMetaFactory from which this factory was obtained.
OMNode	importNode(OMNode child) This method is intended only to be used by Axiom intenals when merging Objects from different Axiom implementations to the DOOM implementation.

Methods inherited from class java.lang.Object

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

Field Detail

metaFactory

private final OMDOMMetaFactory metaFactory

Constructor Detail

OMDOMFactory

public OMDOMFactory(OMDOMMetaFactory metaFactory)

OMDOMFactory

public OMDOMFactory()

Method Detail

getMetaFactory

public OMMetaFactory getMetaFactory()

Description copied from interface: OMFactory

Get the OMMetaFactory from which this factory was obtained. More precisely, if the OMFactory instance has been obtained from a OMMetaFactory using OMMetaFactory.getOMFactory(), OMMetaFactory.getSOAP11Factory() or OMMetaFactory.getSOAP12Factory(), then the return value is the same as the original OMMetaFactory. Since OMAbstractFactory creates a single OMMetaFactory instance per Axiom implementation, this means that this method can be used to check if two OMFactory instances belong to the same Axiom implementation.

Specified by:

getMetaFactory in interface OMFactory

Returns:

the meta factory

createOMDocument

public OMDocument createOMDocument()

Description copied from interface: OMFactory

Creates a new OMDocument.

Specified by:

createOMDocument in interface OMFactory

createOMElement

public OMElement createOMElement(java.lang.String localName,
                                 OMNamespace ns)

Description copied from interface: OMFactory

Create an element with the given name. If a namespace is given, a namespace declaration will be added automatically to the newly created element.

Specified by:

createOMElement in interface OMFactory

Parameters:

localName - the local part of the name; must not be null

ns - the namespace, or null if the element has no namespace

Returns:

the newly created element

createOMElement

public OMElement createOMElement(java.lang.String localName,
                                 OMNamespace ns,
                                 OMContainer parent)
                          throws OMDOMException

Description copied from interface: OMFactory

Create an element with the given name and parent. If the specified OMNamespace has a namespace URI but a null prefix, the method will reuse an existing prefix if a namespace declaration with a matching namespace URI is in scope on the parent or generate a new prefix if no such namespace declaration exists.

If a new prefix is generated or if the specified prefix and namespace URI are not bound in the scope of the parent element, the method will add an appropriate namespace declaration to the new element. Note that this may also occur if null is passed as OMNamespace parameter. In that case, if there is a default namespace declaration with a non empty namespace URI in the scope of the parent element, a namespace declaration needs to be added to the newly created element to override the default namespace.

Specified by:

createOMElement in interface OMFactory

parent - the parent to which the newly created element will be added; this may be null, in which case the behavior of the method is the same as OMFactory.createOMElement(String, OMNamespace)

Returns:

the newly created element

Throws:

OMDOMException

createOMElement

public OMElement createOMElement(java.lang.String localName,
                                 OMContainer parent,
                                 OMXMLParserWrapper builder)

Creates an OMElement with the builder.

Specified by:

createOMElement in interface OMFactoryEx

createOMElement

public OMSourcedElement createOMElement(OMDataSource source)

Description copied from interface: OMFactory

Create a sourced element. If the data source implements QNameAwareOMDataSource then the returned OMSourcedElement will use the information provided through this interface to determine the local name, namespace URI and namespace prefix. For information that is not available (either because the data source doesn't implement QNameAwareOMDataSource or because some of the methods defined by that interface return null) the element will be expanded to determine the missing information. This is done lazily, i.e. only when the information is really required. E.g. this will not occur during serialization of the element.

This is an optional operation which may not be supported by all factories.

Specified by:

createOMElement in interface OMFactory

Parameters:

source - the data source; must not be null

Returns:

the newly created element

createOMElement

public OMElement createOMElement(OMDataSource source,
                                 java.lang.String localName,
                                 OMNamespace ns,
                                 OMContainer parent)

createOMElement

public OMSourcedElement createOMElement(OMDataSource source,
                                        java.lang.String localName,
                                        OMNamespace ns)

Description copied from interface: OMFactory

Create a sourced element with a known local name and namespace URI. If the namespace prefix is known in advance, then the caller should specify it in the provided OMNamespace object. The caller may pass an OMNamespace instance with a null prefix. This indicates that the prefix is unknown and will be determined lazily by expanding the element.

Note that if the provided data source implements QNameAwareOMDataSource, then the information returned by QNameAwareOMDataSource.getPrefix() may be used to determine the prefix. However, this is an unusual use case.

Also note that if the specified namespace URI is empty, then the element can't have a prefix and it is not necessary to expand the element to determine its prefix.

This is an optional operation which may not be supported by all factories.

Specified by:

createOMElement in interface OMFactory

Parameters:

source - the data source; must not be null

localName - the local part of the name of the element produced by the data source; must not be null

ns - the namespace of the element produced by the data source, or null if the element has no namespace

Returns:

the newly created element

createOMElement

public OMSourcedElement createOMElement(OMDataSource source,
                                        javax.xml.namespace.QName qname)

Unsupported.

Specified by:

createOMElement in interface OMFactory

Parameters:

source - the data source; must not be null

qname - the name of the element produced by the data source; must not be null

Returns:

the newly created element

createOMElement

public OMElement createOMElement(java.lang.String localName,
                                 java.lang.String namespaceURI,
                                 java.lang.String prefix)

Description copied from interface: OMFactory

Create an element with the given name. If a namespace is given, a namespace declaration will be added automatically to the newly created element.

Specified by:

createOMElement in interface OMFactory

Parameters:

localName - the local part of the name; must not be null

namespaceURI - the namespace URI, or the empty string if the element has no namespace; must not be null

prefix - the namespace prefix, or null if a prefix should be generated

Returns:

the newly created OMElement.

createOMElement

public OMElement createOMElement(javax.xml.namespace.QName qname,
                                 OMContainer parent)
                          throws OMException

Creates a new OMDOM Element node and adds it to the given parent.

Specified by:

createOMElement in interface OMFactory

Parameters:

qname - the QName defining the name of the element to be created

parent - the parent to which the newly created element will be added; this may be null, in which case the behavior of the method is the same as OMFactory.createOMElement(QName)

Returns:

the new element

Throws:

OMException

See Also:

createOMElement(String, OMNamespace, OMContainer), OMFactory.createOMElement( javax.xml.namespace.QName, org.apache.axiom.om.OMContainer)

createOMElement

public OMElement createOMElement(javax.xml.namespace.QName qname)
                          throws OMException

Create an OMElement with the given QName

If the QName contains a prefix, we will ensure that an OMNamespace is created mapping the given namespace to the given prefix. If no prefix is passed, we'll create a generated one.

Specified by:

createOMElement in interface OMFactory

Parameters:

qname -

Returns:

the new OMElement.

Throws:

OMException

createOMNamespace

public OMNamespace createOMNamespace(java.lang.String uri,
                                     java.lang.String prefix)

Creates a new OMNamespace.

Specified by:

createOMNamespace in interface OMFactory

Parameters:

uri - the namespace URI; must not be null

prefix - the prefix

Returns:

the OMNamespace instance

See Also:

OMFactory.createOMNamespace(String, String)

createOMText

public OMText createOMText(OMContainer parent,
                           java.lang.String text)

Description copied from interface: OMFactory

Creates a new OMText node with the given value and appends it to the given parent element.

Specified by:

createOMText in interface OMFactory

Parameters:

parent - the parent to which the newly created text node will be added; this may be null, in which case the behavior of the method is the same as OMFactory.createOMText(String)

Returns:

Returns OMText.

createOMText

public OMText createOMText(OMContainer parent,
                           javax.xml.namespace.QName text)

Specified by:

createOMText in interface OMFactory

text - - This text itself can contain a namespace inside it.

createOMText

public OMText createOMText(OMContainer parent,
                           javax.xml.namespace.QName text,
                           int type)

Specified by:

createOMText in interface OMFactory

text - - This text itself can contain a namespace inside it.

createOMText

public OMText createOMText(OMContainer parent,
                           java.lang.String text,
                           int type)

Specified by:

createOMText in interface OMFactory

type - the node type: OMNode.TEXT_NODE, OMNode.CDATA_SECTION_NODE or OMNode.SPACE_NODE

Returns:

Returns OMText.

createOMText

public OMText createOMText(OMContainer parent,
                           java.lang.String text,
                           int type,
                           boolean fromBuilder)

Specified by:

createOMText in interface OMFactoryEx

createOMText

public OMText createOMText(OMContainer parent,
                           OMText source)

Description copied from interface: OMFactory

Create OMText node that is a copy of the source text node

Specified by:

createOMText in interface OMFactory

Returns:

TODO

createOMText

public OMText createOMText(OMContainer parent,
                           char[] charArary,
                           int type)

Specified by:

createOMText in interface OMFactory

createOMText

public OMText createOMText(java.lang.String s)

Creates a OMDOM Text node carrying the given value.

Specified by:

createOMText in interface OMFactory

Returns:

Returns OMText.

See Also:

OMFactory.createOMText(String)

createOMText

public OMText createOMText(java.lang.String text,
                           int type)

Creates a Character node of the given type.

Specified by:

createOMText in interface OMFactory

type - the node type: OMNode.TEXT_NODE, OMNode.CDATA_SECTION_NODE or OMNode.SPACE_NODE

Returns:

Returns OMText.

See Also:

OMFactory.createOMText(String, int)

createOMText

public OMText createOMText(java.lang.String text,
                           java.lang.String mimeType,
                           boolean optimize)

Creates a new OMDOM Text node with the value of the given text value along with the MTOM optimization parameters and returns it.

Specified by:

createOMText in interface OMFactory

See Also:

OMFactory.createOMText(String, String, boolean)

createOMText

public OMText createOMText(java.lang.Object dataHandler,
                           boolean optimize)

Creates a new OMDOM Text node with the given datahandler and the given MTOM optimization configuration and returns it.

Specified by:

createOMText in interface OMFactory

See Also:

OMFactory.createOMText(Object, boolean)

createOMText

public OMText createOMText(OMContainer parent,
                           java.lang.Object dataHandler,
                           boolean optimize,
                           boolean fromBuilder)

Specified by:

createOMText in interface OMFactoryEx

createOMText

public OMText createOMText(java.lang.String contentID,
                           DataHandlerProvider dataHandlerProvider,
                           boolean optimize)

Description copied from interface: OMFactory

Create a binary OMText node supporting deferred loading of the content.

Specified by:

createOMText in interface OMFactory

Parameters:

contentID - the content ID identifying the binary content; may be null

dataHandlerProvider - used to load the DataHandler when requested from the returned OMText node

optimize - determines whether the binary content should be optimized

Returns:

TODO

createOMText

public OMText createOMText(OMContainer parent,
                           java.lang.String s,
                           java.lang.String mimeType,
                           boolean optimize)

Creates an OMDOM Text node, adds it to the give parent element and returns it.

Specified by:

createOMText in interface OMFactory

See Also:

OMFactory.createOMText(OMContainer, String, String, boolean)

createOMAttribute

public OMAttribute createOMAttribute(java.lang.String localName,
                                     OMNamespace ns,
                                     java.lang.String value)

Description copied from interface: OMFactory

Create an attribute with the given name and value. If the provided OMNamespace object has a null prefix, then a prefix will be generated, except if the namespace URI is the empty string, in which case the result is the same as if a null OMNamespace was given.

Specified by:

createOMAttribute in interface OMFactory

Returns:

the newly created attribute

createOMDocType

public OMDocType createOMDocType(OMContainer parent,
                                 java.lang.String rootName,
                                 java.lang.String publicId,
                                 java.lang.String systemId,
                                 java.lang.String internalSubset)

Description copied from interface: OMFactory

Creates DTD (DOCTYPE declaration) node.

Specified by:

createOMDocType in interface OMFactory

Parameters:

parent - the parent to which the newly created text node will be added; this may be null

rootName - the root name, i.e. the name immediately following the DOCTYPE keyword

publicId - the public ID of the external subset, or null if there is no external subset or no public ID has been specified for the external subset

systemId - the system ID of the external subset, or null if there is no external subset

internalSubset - the internal subset, or null if there is none

Returns:

the newly created OMDocType node

createOMDocType

public OMDocType createOMDocType(OMContainer parent,
                                 java.lang.String rootName,
                                 java.lang.String publicId,
                                 java.lang.String systemId,
                                 java.lang.String internalSubset,
                                 boolean fromBuilder)

Specified by:

createOMDocType in interface OMFactoryEx

createOMProcessingInstruction

public OMProcessingInstruction createOMProcessingInstruction(OMContainer parent,
                                                             java.lang.String piTarget,
                                                             java.lang.String piData)

Description copied from interface: OMFactory

Creates a PI.

Specified by:

createOMProcessingInstruction in interface OMFactory

Returns:

Returns OMProcessingInstruction.

createOMProcessingInstruction

public OMProcessingInstruction createOMProcessingInstruction(OMContainer parent,
                                                             java.lang.String piTarget,
                                                             java.lang.String piData,
                                                             boolean fromBuilder)

Specified by:

createOMProcessingInstruction in interface OMFactoryEx

createOMComment

public OMComment createOMComment(OMContainer parent,
                                 java.lang.String content)

Description copied from interface: OMFactory

Creates a comment.

Specified by:

createOMComment in interface OMFactory

Returns:

Returns OMComment.

createOMComment

public OMComment createOMComment(OMContainer parent,
                                 java.lang.String content,
                                 boolean fromBuilder)

Specified by:

createOMComment in interface OMFactoryEx

createOMDocument

public OMDocument createOMDocument(OMXMLParserWrapper builder)

Specified by:

createOMDocument in interface OMFactoryEx

createOMEntityReference

public OMEntityReference createOMEntityReference(OMContainer parent,
                                                 java.lang.String name)

Description copied from interface: OMFactory

Create an entity reference.

Specified by:

createOMEntityReference in interface OMFactory

Parameters:

parent - the parent to which the newly created entity reference node will be added; this may be null

name - the name of the entity

Returns:

the newly created OMEntityReference node

createOMEntityReference

public OMEntityReference createOMEntityReference(OMContainer parent,
                                                 java.lang.String name,
                                                 java.lang.String replacementText,
                                                 boolean fromBuilder)

Specified by:

createOMEntityReference in interface OMFactoryEx

importNode

public OMNode importNode(OMNode child)

This method is intended only to be used by Axiom intenals when merging Objects from different Axiom implementations to the DOOM implementation.

Specified by:

importNode in interface OMFactoryEx

Parameters:

child -