org.apache.axiom.om
Interface OMSourcedElement
- All Superinterfaces:
- OMContainer, OMElement, OMNode, OMSerializable
- All Known Subinterfaces:
- SOAPHeaderBlock
- All Known Implementing Classes:
- OMSourcedElementImpl, SOAP11HeaderBlockImpl, SOAP11HeaderBlockImpl, SOAP12HeaderBlockImpl, SOAP12HeaderBlockImpl, SOAPHeaderBlockImpl, SOAPHeaderBlockImpl
public interface OMSourcedElement
- extends OMElement
Element whose data is backed by an arbitrary Java object. The backing Java object is accessed
via the OMDataSource
(or OMDataSourceExt
) interface.
An OMSourcedElement can be in one of two states:
- Not Expanded
- In this state the backing object is used to read and write the XML.
- Expanded
- In this state, the OMSourcedElement is backed by a normal OM tree.
Here are the steps to place an arbitrary java object into the OM tree:
- Write an
OMDataSourceExt
implementation that provides access to your Java
object.
- Use
OMFactory.createOMElement(OMDataSource, String, OMNamespace)
to create
the OMSourcedElement.
- Attach the OMSourcedElement to the tree.
Methods inherited from interface org.apache.axiom.om.OMElement |
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getQName, getText, getTextAsQName, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume |
Methods inherited from interface org.apache.axiom.om.OMContainer |
addChild, buildNext, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching |
isExpanded
boolean isExpanded()
- Returns:
- true if tree is expanded or being expanded.
getDataSource
OMDataSource getDataSource()
- Returns:
- OMDataSource
setDataSource
OMDataSource setDataSource(OMDataSource dataSource)
- Replace an existing OMDataSource with a new one.
- Parameters:
dataSource
- new OMDataSource
- Returns:
- null or old OMDataSource
Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.