|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.dom.NodeImpl | +--org.apache.xerces.dom.ChildNode | +--org.apache.xerces.dom.ParentNode | +--org.apache.xerces.dom.CoreDocumentImpl | +--org.apache.xerces.dom.DocumentImpl
The Document interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.
The DocumentImpl class also implements the DOM Level 2 DocumentTraversal interface. This interface is comprised of factory methods needed to create NodeIterators and TreeWalkers. The process of creating NodeIterator objects also adds these references to this document. After finishing with an iterator it is important to remove the object using the remove methods in this implementation. This allows the release of the references from the iterator objects to the DOM Nodes.
Note: When any node in the document is serialized, the entire document is serialized along with it.
Field Summary | |
protected java.util.Hashtable |
eventListeners
Table for event listeners registered to this document nodes. |
protected java.util.Vector |
iterators
Iterators |
protected boolean |
mutationEvents
Bypass mutation events firing. |
protected java.util.Vector |
ranges
Ranges |
Fields inherited from class org.apache.xerces.dom.CoreDocumentImpl |
actualEncoding, allowGrammarAccess, changes, docElement, docType, encoding, errorChecking, identifiers, standalone, userData, version |
Fields inherited from class org.apache.xerces.dom.ParentNode |
firstChild, fNodeListCache, ownerDocument |
Fields inherited from class org.apache.xerces.dom.ChildNode |
nextSibling, previousSibling |
Fields inherited from class org.apache.xerces.dom.NodeImpl |
ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, IGNORABLEWS, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, UNNORMALIZED |
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Fields inherited from interface org.apache.xerces.dom3.Node3 |
TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE |
Constructor Summary | |
DocumentImpl()
NON-DOM: Actually creating a Document is outside the DOM's spec, since it has to operate in terms of a particular implementation. |
|
DocumentImpl(boolean grammarAccess)
Constructor. |
|
DocumentImpl(org.w3c.dom.DocumentType doctype)
For DOM2 support. |
|
DocumentImpl(org.w3c.dom.DocumentType doctype,
boolean grammarAccess)
For DOM2 support. |
Method Summary | |
void |
abort()
DOM Level 3 WD - Experimental. |
protected void |
addEventListener(NodeImpl node,
java.lang.String type,
org.w3c.dom.events.EventListener listener,
boolean useCapture)
Introduced in DOM Level 2. |
org.w3c.dom.Node |
cloneNode(boolean deep)
Deep-clone a document, including fixing ownerDoc for the cloned children. |
org.w3c.dom.events.Event |
createEvent(java.lang.String type)
Introduced in DOM Level 2. |
org.w3c.dom.traversal.NodeIterator |
createNodeIterator(org.w3c.dom.Node root,
int whatToShow,
org.w3c.dom.traversal.NodeFilter filter,
boolean entityReferenceExpansion)
Create and return a NodeIterator. |
org.w3c.dom.traversal.NodeIterator |
createNodeIterator(org.w3c.dom.Node root,
short whatToShow,
org.w3c.dom.traversal.NodeFilter filter)
NON-DOM extension: Create and return a NodeIterator. |
org.w3c.dom.ranges.Range |
createRange()
This interface can be obtained from the object implementing the Document interface using binding-specific casting
methods. |
org.w3c.dom.traversal.TreeWalker |
createTreeWalker(org.w3c.dom.Node root,
int whatToShow,
org.w3c.dom.traversal.NodeFilter filter,
boolean entityReferenceExpansion)
Create and return a TreeWalker. |
org.w3c.dom.traversal.TreeWalker |
createTreeWalker(org.w3c.dom.Node root,
short whatToShow,
org.w3c.dom.traversal.NodeFilter filter)
NON-DOM extension: Create and return a TreeWalker. |
protected void |
dispatchAggregateEvents(NodeImpl node,
AttrImpl enclosingAttr,
java.lang.String oldvalue,
short change)
NON-DOM INTERNAL: Generate the "aggregated" post-mutation events DOMAttrModified and DOMSubtreeModified. |
protected void |
dispatchAggregateEvents(NodeImpl node,
org.apache.xerces.dom.DocumentImpl.EnclosingAttr ea)
NON-DOM INTERNAL: Convenience wrapper for calling dispatchAggregateEvents when the context was established by savedEnclosingAttr . |
protected boolean |
dispatchEvent(NodeImpl node,
org.w3c.dom.events.Event event)
Introduced in DOM Level 2. |
protected void |
dispatchEventToSubtree(NodeImpl node,
org.w3c.dom.Node n,
org.w3c.dom.events.Event e)
NON-DOM INTERNAL: DOMNodeInsertedIntoDocument and ...RemovedFrom... |
boolean |
getAsync()
DOM Level 3 WD - Experimental. |
protected java.util.Vector |
getEventListeners(NodeImpl n)
Retreive event listener registered on a given node |
org.w3c.dom.DOMImplementation |
getImplementation()
Retrieve information describing the abilities of this particular DOM implementation. |
boolean |
load(java.lang.String uri)
DOM Level 3 WD - Experimental. |
boolean |
loadXML(java.lang.String source)
DOM Level 3 WD - Experimental. |
protected void |
removeEventListener(NodeImpl node,
java.lang.String type,
org.w3c.dom.events.EventListener listener,
boolean useCapture)
Introduced in DOM Level 2. |
protected void |
saveEnclosingAttr(NodeImpl node)
NON-DOM INTERNAL: Pre-mutation context check, in preparation for later generating DOMAttrModified events. |
java.lang.String |
saveXML(org.w3c.dom.Node snode)
DOM Level 3 WD - Experimental. |
void |
setAsync(boolean async)
DOM Level 3 WD - Experimental. |
protected void |
setEventListeners(NodeImpl n,
java.util.Vector listeners)
Store event listener registered on a given node This is another place where we could use weak references! Indeed, the node here won't be GC'ed as long as some listener is registered on it, since the eventsListeners table will have a reference to the node. |
Methods inherited from class org.apache.xerces.dom.ParentNode |
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setReadOnly, synchronizeChildren |
Methods inherited from class org.apache.xerces.dom.ChildNode |
getNextSibling, getParentNode, getPreviousSibling |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
addEventListener, appendChild, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getInterface, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, hasAttributes, isSameNode, isSupported, lookupNamespacePrefix, lookupNamespaceURI, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, isSupported, normalize, setNodeValue, setPrefix |
Field Detail |
protected java.util.Vector iterators
protected java.util.Vector ranges
protected java.util.Hashtable eventListeners
protected boolean mutationEvents
Constructor Detail |
public DocumentImpl()
public DocumentImpl(boolean grammarAccess)
public DocumentImpl(org.w3c.dom.DocumentType doctype)
public DocumentImpl(org.w3c.dom.DocumentType doctype, boolean grammarAccess)
Method Detail |
public org.w3c.dom.Node cloneNode(boolean deep)
cloneNode
in class CoreDocumentImpl
deep
- boolean, iff true replicate childrenpublic org.w3c.dom.DOMImplementation getImplementation()
getImplementation
in class CoreDocumentImpl
public org.w3c.dom.traversal.NodeIterator createNodeIterator(org.w3c.dom.Node root, short whatToShow, org.w3c.dom.traversal.NodeFilter filter)
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.public org.w3c.dom.traversal.NodeIterator createNodeIterator(org.w3c.dom.Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter, boolean entityReferenceExpansion)
createNodeIterator
in interface org.w3c.dom.traversal.DocumentTraversal
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.entityReferenceExpansion
- true to expand the contents of
EntityReference nodespublic org.w3c.dom.traversal.TreeWalker createTreeWalker(org.w3c.dom.Node root, short whatToShow, org.w3c.dom.traversal.NodeFilter filter)
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.public org.w3c.dom.traversal.TreeWalker createTreeWalker(org.w3c.dom.Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter, boolean entityReferenceExpansion)
createTreeWalker
in interface org.w3c.dom.traversal.DocumentTraversal
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.entityReferenceExpansion
- true to expand the contents of
EntityReference nodespublic org.w3c.dom.ranges.Range createRange()
org.w3c.dom.ranges.DocumentRange
Document
interface using binding-specific casting
methods.createRange
in interface org.w3c.dom.ranges.DocumentRange
org.w3c.dom.ranges.DocumentRange
ownerDocument
.public org.w3c.dom.events.Event createEvent(java.lang.String type) throws org.w3c.dom.DOMException
Create and return Event objects.
createEvent
in interface org.w3c.dom.events.DocumentEvent
type
- The eventType parameter specifies the type of Event
interface to be created. If the Event interface specified is supported
by the implementation this method will return a new Event of the
interface type requested. If the Event is to be dispatched via the
dispatchEvent method the appropriate event init method must be called
after creation in order to initialize the Event's values. As an
example, a user wishing to synthesize some kind of Event would call
createEvent with the parameter "Events". The initEvent method could then
be called on the newly created Event to set the specific type of Event
to be dispatched and set its context information.org.w3c.dom.DOMException
- NOT_SUPPORTED_ERR: Raised if the implementation
does not support the type of Event interface requestedprotected void setEventListeners(NodeImpl n, java.util.Vector listeners)
protected java.util.Vector getEventListeners(NodeImpl n)
protected void addEventListener(NodeImpl node, java.lang.String type, org.w3c.dom.events.EventListener listener, boolean useCapture)
Register an event listener with this Node. A listener may be independently registered as both Capturing and Bubbling, but may only be registered once per role; redundant registrations are ignored.
addEventListener
in class CoreDocumentImpl
node
- node to add listener totype
- Event name (NOT event group!) to listen for.listener
- Who gets called when event is dispatcheduseCapture
- True iff listener is registered on
capturing phase rather than at-target or bubblingprotected void removeEventListener(NodeImpl node, java.lang.String type, org.w3c.dom.events.EventListener listener, boolean useCapture)
Deregister an event listener previously registered with this Node. A listener must be independently removed from the Capturing and Bubbling roles. Redundant removals (of listeners not currently registered for this role) are ignored.
removeEventListener
in class CoreDocumentImpl
node
- node to remove listener fromtype
- Event name (NOT event group!) to listen for.listener
- Who gets called when event is dispatcheduseCapture
- True iff listener is registered on
capturing phase rather than at-target or bubblingprotected boolean dispatchEvent(NodeImpl node, org.w3c.dom.events.Event event)
Distribution engine for DOM Level 2 Events.
Event propagation runs as follows:
Note that registration of handlers during processing of an event does not take effect during this phase of this event; they will not be called until the next time this node is visited by dispatchEvent. On the other hand, removals take effect immediately.
If an event handler itself causes events to be dispatched, they are processed synchronously, before processing resumes on the event which triggered them. Please be aware that this may result in events arriving at listeners "out of order" relative to the actual sequence of requests.
Note that our implementation resets the event's stop/prevent flags when dispatch begins. I believe the DOM's intent is that event objects be redispatchable, though it isn't stated in those terms.
dispatchEvent
in class CoreDocumentImpl
node
- node to dispatch toevent
- the event object to be dispatched to
registered EventListenerspreventDefault()
method was invoked by an EventListener; otherwise false.protected void dispatchEventToSubtree(NodeImpl node, org.w3c.dom.Node n, org.w3c.dom.events.Event e)
***** At the moment I'm being sloppy and using the normal capture dispatcher on every node. This could be optimized hugely by writing a capture engine that tracks our position in the tree to update the capture chain without repeated chases up to root.
node
- node to dispatch ton
- node which was directly inserted or removede
- event to be sent to that node and its subtreeprotected void dispatchAggregateEvents(NodeImpl node, org.apache.xerces.dom.DocumentImpl.EnclosingAttr ea)
savedEnclosingAttr
.node
- node to dispatch toea
- description of Attr affected by current operationprotected void dispatchAggregateEvents(NodeImpl node, AttrImpl enclosingAttr, java.lang.String oldvalue, short change)
To manage this, use the "internal" versions of insert and remove with MUTATION_LOCAL, then make an explicit call to this routine at the higher level. Some examples now exist in our code.
node
- The node to dispatch toenclosingAttr
- The Attr node (if any) whose value has been changed
as a result of the DOM operation. Null if none such.oldValue
- The String value previously held by the
enclosingAttr. Ignored if none such.change
- Type of modification to the attr. See
MutationEvent.attrChangeprotected void saveEnclosingAttr(NodeImpl node)
node
- node to get enclosing attribute forpublic boolean getAsync()
true
the load method returns control to the caller before the document has
completed loading. The default value of this property is
false
.
false
but we
need to check with Mozilla and IE.getAsync
in interface org.apache.xerces.dom3.ls.DocumentLS
public void setAsync(boolean async)
true
the load method returns control to the caller before the document has
completed loading. The default value of this property is
false
.
false
but we
need to check with Mozilla and IE.setAsync
in interface org.apache.xerces.dom3.ls.DocumentLS
public void abort()
load
being invoked the loading and parsing is
immediately aborted. The possibly partial result of parsing the
document is discarded and the document is cleared.abort
in interface org.apache.xerces.dom3.ls.DocumentLS
public boolean load(java.lang.String uri)
ParseErrorEvent
).load
in interface org.apache.xerces.dom3.ls.DocumentLS
uri
- The URI reference for the XML file to be loaded. If this is
a relative URI...true
load
returns
true
if the document load was successfully initiated.
If an error occurred when initiating the document load
load
returns false
.If async is set to
false
load
returns true
if
the document was successfully loaded and parsed. If an error
occurred when either loading or parsing the URI load
returns false
.public boolean loadXML(java.lang.String source)
loadXML
in interface org.apache.xerces.dom3.ls.DocumentLS
source
- A string containing an XML document.true
if parsing the input string succeeded
without errors, otherwise false
.public java.lang.String saveXML(org.w3c.dom.Node snode) throws org.w3c.dom.DOMException
saveXML
in interface org.apache.xerces.dom3.ls.DocumentLS
snode
- Specifies what to serialize, if this parameter is
null
the whole document is serialized, if it's
non-null the given node is serialized.null
.org.w3c.dom.DOMException
- WRONG_DOCUMENT_ERR: Raised if the node passed in as the node
parameter is from an other document.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |