org.apache.axiom.om.impl.common.factory

Class AbstractOMMetaFactory

java.lang.Object

org.apache.axiom.om.impl.common.factory.AbstractOMMetaFactory

All Implemented Interfaces:

OMMetaFactory, OMMetaFactoryEx

Direct Known Subclasses:

OMDOMMetaFactory, OMLinkedListMetaFactory

public abstract class AbstractOMMetaFactory
extends java.lang.Object
implements OMMetaFactoryEx

Base class for OMMetaFactory implementations that make use of the standard builders (StAXOMBuilder and its subclasses).

Constructor Summary

Constructors

Constructor and Description
AbstractOMMetaFactory()

Method Summary

Modifier and Type	Method and Description
OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, org.w3c.dom.Node node, boolean expandEntityReferences) Create an object model builder for plain XML that gets its input from a DOM tree.
OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, javax.xml.transform.sax.SAXSource source, boolean expandEntityReferences) Create an object model builder for plain XML that gets its input from a SAXSource.
OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, javax.xml.transform.Source source) Create an object model builder for plain XML that gets its input from a Source.
OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, StAXParserConfiguration configuration, org.xml.sax.InputSource is) Create an object model builder for plain XML that reads a document from the provided input source.
OMXMLParserWrapper	createOMBuilder(StAXParserConfiguration configuration, OMFactory omFactory, org.xml.sax.InputSource rootPart, MimePartProvider mimePartProvider) Create an XOP aware object model builder.
SOAPModelBuilder	createSOAPModelBuilder(StAXParserConfiguration configuration, org.xml.sax.InputSource is) Create an object model builder for SOAP that reads a message from the provided input source.
SOAPModelBuilder	createSOAPModelBuilder(StAXParserConfiguration configuration, SOAPFactory soapFactory, org.xml.sax.InputSource rootPart, MimePartProvider mimePartProvider) Create an MTOM aware object model builder.
OMXMLParserWrapper	createStAXOMBuilder(OMFactory omFactory, javax.xml.stream.XMLStreamReader parser) Create an object model builder for plain XML that pulls events from a StAX stream reader.
SOAPModelBuilder	createStAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser) Create an object model builder for SOAP that pulls events from a StAX stream reader.
private static javax.xml.stream.XMLStreamReader	createXMLStreamReader(StAXParserConfiguration configuration, org.xml.sax.InputSource is)
private static javax.xml.stream.XMLStreamReader	getXMLStreamReader(javax.xml.stream.XMLStreamReader originalReader)
private static OMXMLParserWrapper	internalCreateStAXOMBuilder(OMFactory omFactory, javax.xml.stream.XMLStreamReader parser)
private SOAPModelBuilder	internalCreateStAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser)

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.soap.impl.builder.OMMetaFactoryEx

createSOAPMessage

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

getOMFactory, getSOAP11Factory, getSOAP12Factory

Constructor Detail

AbstractOMMetaFactory

public AbstractOMMetaFactory()

Method Detail

createXMLStreamReader

private static javax.xml.stream.XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration,
                                                                      org.xml.sax.InputSource is)

getXMLStreamReader

private static javax.xml.stream.XMLStreamReader getXMLStreamReader(javax.xml.stream.XMLStreamReader originalReader)

internalCreateStAXOMBuilder

private static OMXMLParserWrapper internalCreateStAXOMBuilder(OMFactory omFactory,
                                                              javax.xml.stream.XMLStreamReader parser)

createStAXOMBuilder

public OMXMLParserWrapper createStAXOMBuilder(OMFactory omFactory,
                                              javax.xml.stream.XMLStreamReader parser)

Description copied from interface: OMMetaFactory

Create an object model builder for plain XML that pulls events from a StAX stream reader.

The implementation must perform namespace repairing, i.e. it must add appropriate namespace declarations if undeclared namespaces appear in the StAX stream.

Specified by:

createStAXOMBuilder in interface OMMetaFactory

Parameters:

omFactory - The object model factory to use. This factory must be obtained from the same OMMetaFactory instance as the one used to invoke this method. In general the factory will be retrieved from OMMetaFactory.getOMFactory()), but in some cases it may be necessary to pass a SOAPFactory instance, although this method will never produce a SOAP infoset.

parser - the stream reader to read the XML data from

Returns:

the builder

createOMBuilder

public OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                          StAXParserConfiguration configuration,
                                          org.xml.sax.InputSource is)

Description copied from interface: OMMetaFactory

Create an object model builder for plain XML that reads a document from the provided input source.

Specified by:

createOMBuilder in interface OMMetaFactory

Parameters:

omFactory - The object model factory to use. This factory must be obtained from the same OMMetaFactory instance as the one used to invoke this method. In general the factory will be retrieved from OMMetaFactory.getOMFactory()), but in some cases it may be necessary to pass a SOAPFactory instance, although this method will never produce a SOAP infoset.

configuration - the parser configuration to use

is - the source of the XML document

Returns:

the builder

createOMBuilder

public OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                          javax.xml.transform.Source source)

Description copied from interface: OMMetaFactory

Create an object model builder for plain XML that gets its input from a Source.

Specified by:

createOMBuilder in interface OMMetaFactory

Parameters:

omFactory - The object model factory to use. This factory must be obtained from the same OMMetaFactory instance as the one used to invoke this method. In general the factory will be retrieved from OMMetaFactory.getOMFactory()), but in some cases it may be necessary to pass a SOAPFactory instance, although this method will never produce a SOAP infoset.

source - the source of the XML document

Returns:

the builder

createOMBuilder

public OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                          org.w3c.dom.Node node,
                                          boolean expandEntityReferences)

Description copied from interface: OMMetaFactory

Create an object model builder for plain XML that gets its input from a DOM tree.

Specified by:

createOMBuilder in interface OMMetaFactory

Parameters:

omFactory - The object model factory to use. This factory must be obtained from the same OMMetaFactory instance as the one used to invoke this method. In general the factory will be retrieved from OMMetaFactory.getOMFactory()), but in some cases it may be necessary to pass a SOAPFactory instance, although this method will never produce a SOAP infoset.

node - the DOM node; must be a Node.DOCUMENT_NODE or Node.ELEMENT_NODE

expandEntityReferences - Determines how EntityReference nodes are handled:

• If the parameter is false then a single OMEntityReference will be created for each EntityReference. The child nodes of EntityReference nodes are not taken into account.
• If the parameter is true then no OMEntityReference nodes are created and the children of EntityReference nodes are converted and inserted into the Axiom tree.

Returns:

the builder

createOMBuilder

public OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                          javax.xml.transform.sax.SAXSource source,
                                          boolean expandEntityReferences)

Description copied from interface: OMMetaFactory

Create an object model builder for plain XML that gets its input from a SAXSource.

Specified by:

createOMBuilder in interface OMMetaFactory

Parameters:

omFactory - The object model factory to use. This factory must be obtained from the same OMMetaFactory instance as the one used to invoke this method. In general the factory will be retrieved from OMMetaFactory.getOMFactory()), but in some cases it may be necessary to pass a SOAPFactory instance, although this method will never produce a SOAP infoset.

source - the source of the XML document

expandEntityReferences - Determines how entity references (i.e. LexicalHandler.startEntity(String) and LexicalHandler.endEntity(String) events) are handled:

• If the parameter is false then a single OMEntityReference will be created for each pair of LexicalHandler.startEntity(String) and LexicalHandler.endEntity(String) events. Other events reported between these two events are not taken into account.
• If the parameter is true then no OMEntityReference nodes are created and LexicalHandler.startEntity(String) and LexicalHandler.endEntity(String) events are ignored. However, events between LexicalHandler.startEntity(String) and LexicalHandler.endEntity(String) are processed normally.

Returns:

the builder

createOMBuilder

public OMXMLParserWrapper createOMBuilder(StAXParserConfiguration configuration,
                                          OMFactory omFactory,
                                          org.xml.sax.InputSource rootPart,
                                          MimePartProvider mimePartProvider)

Description copied from interface: OMMetaFactory

Create an XOP aware object model builder.

Specified by:

createOMBuilder in interface OMMetaFactory

Parameters:

configuration - the parser configuration to use

omFactory - The object model factory to use. This factory must be obtained from the same OMMetaFactory instance as the one used to invoke this method.

rootPart - the source of the root part of the XOP message

mimePartProvider - the provider from which MIME parts referenced in the root part will be retrieved

Returns:

the builder

internalCreateStAXSOAPModelBuilder

private SOAPModelBuilder internalCreateStAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser)

createStAXSOAPModelBuilder

public SOAPModelBuilder createStAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser)

Description copied from interface: OMMetaFactory

Create an object model builder for SOAP that pulls events from a StAX stream reader. The implementation will select the appropriate SOAPFactory based on the namespace URI of the SOAP envelope.

Specified by:

createStAXSOAPModelBuilder in interface OMMetaFactory

Parameters:

parser - the stream reader to read the SOAP message from

Returns:

the builder

createSOAPModelBuilder

public SOAPModelBuilder createSOAPModelBuilder(StAXParserConfiguration configuration,
                                               org.xml.sax.InputSource is)

Description copied from interface: OMMetaFactory

Create an object model builder for SOAP that reads a message from the provided input source. The implementation will select the appropriate SOAPFactory based on the namespace URI of the SOAP envelope.

Specified by:

createSOAPModelBuilder in interface OMMetaFactory

Parameters:

configuration - the parser configuration to use; for security reasons, this should in general be StAXParserConfiguration.SOAP

is - the source of the SOAP message

Returns:

the builder

createSOAPModelBuilder

public SOAPModelBuilder createSOAPModelBuilder(StAXParserConfiguration configuration,
                                               SOAPFactory soapFactory,
                                               org.xml.sax.InputSource rootPart,
                                               MimePartProvider mimePartProvider)

Description copied from interface: OMMetaFactory

Create an MTOM aware object model builder.

Specified by:

createSOAPModelBuilder in interface OMMetaFactory

Parameters:

configuration - the parser configuration to use; for security reasons, this should in general be StAXParserConfiguration.SOAP

soapFactory - the SOAPFactory to use, or null if the implementation should select the appropriate SOAPFactory based on the namespace URI of the SOAP envelope.

rootPart - the source of the root part of the MTOM message

mimePartProvider - the provider from which MIME parts referenced in the root part will be retrieved

Returns:

the builder