Java > Open Source Codes > com > sun > org > apache > xml > internal > dtm > DTM


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 /*
17  * $Id: DTM.java,v 1.13 2004/02/16 23:03:44 minchau Exp $
18  */
19 package com.sun.org.apache.xml.internal.dtm;
20
21 import javax.xml.transform.SourceLocator ;
22
23 import com.sun.org.apache.xml.internal.utils.XMLString;
24
25 /**
26  * <code>DTM</code> is an XML document model expressed as a table
27  * rather than an object tree. It attempts to provide an interface to
28  * a parse tree that has very little object creation. (DTM
29  * implementations may also support incremental construction of the
30  * model, but that's hidden from the DTM API.)
31  *
32  * <p>Nodes in the DTM are identified by integer "handles". A handle must
33  * be unique within a process, and carries both node identification and
34  * document identification. It must be possible to compare two handles
35  * (and thus their nodes) for identity with "==".</p>
36  *
37  * <p>Namespace URLs, local-names, and expanded-names can all be
38  * represented by and tested as integer ID values. An expanded name
39  * represents (and may or may not directly contain) a combination of
40  * the URL ID, and the local-name ID. Note that the namespace URL id
41  * can be 0, which should have the meaning that the namespace is null.
42  * For consistancy, zero should not be used for a local-name index. </p>
43  *
44  * <p>Text content of a node is represented by an index and length,
45  * permitting efficient storage such as a shared FastStringBuffer.</p>
46  *
47  * <p>The model of the tree, as well as the general navigation model,
48  * is that of XPath 1.0, for the moment. The model will eventually be
49  * adapted to match the XPath 2.0 data model, XML Schema, and
50  * InfoSet.</p>
51  *
52  * <p>DTM does _not_ directly support the W3C's Document Object
53  * Model. However, it attempts to come close enough that an
54  * implementation of DTM can be created that wraps a DOM and vice
55  * versa.</p>
56  *
57  * <p><strong>Please Note:</strong> The DTM API is still
58  * <strong>Subject To Change.</strong> This wouldn't affect most
59  * users, but might require updating some extensions.</p>
60  *
61  * <p> The largest change being contemplated is a reconsideration of
62  * the Node Handle representation. We are still not entirely sure
63  * that an integer packed with two numeric subfields is really the
64  * best solution. It has been suggested that we move up to a Long, to
65  * permit more nodes per document without having to reduce the number
66  * of slots in the DTMManager. There's even been a proposal that we
67  * replace these integers with "cursor" objects containing the
68  * internal node id and a pointer to the actual DTM object; this might
69  * reduce the need to continuously consult the DTMManager to retrieve
70  * the latter, and might provide a useful "hook" back into normal Java
71  * heap management. But changing this datatype would have huge impact
72  * on Xalan's internals -- especially given Java's lack of C-style
73  * typedefs -- so we won't cut over unless we're convinced the new
74  * solution really would be an improvement!</p>
75  * */
76 public interface DTM
77 {
78
79   /**
80    * Null node handles are represented by this value.
81    */
82   public static final int NULL = -1;
83
84   // These nodeType mnemonics and values are deliberately the same as those
85 // used by the DOM, for convenient mapping
86 //
87 // %REVIEW% Should we actually define these as initialized to,
88 // eg. org.w3c.dom.Document.ELEMENT_NODE?
89
90   /**
91    * The node is a <code>Root</code>.
92    */
93   public static final short ROOT_NODE = 0;
94   
95   /**
96    * The node is an <code>Element</code>.
97    */
98   public static final short ELEMENT_NODE = 1;
99
100   /**
101    * The node is an <code>Attr</code>.
102    */
103   public static final short ATTRIBUTE_NODE = 2;
104
105   /**
106    * The node is a <code>Text</code> node.
107    */
108   public static final short TEXT_NODE = 3;
109
110   /**
111    * The node is a <code>CDATASection</code>.
112    */
113   public static final short CDATA_SECTION_NODE = 4;
114
115   /**
116    * The node is an <code>EntityReference</code>.
117    */
118   public static final short ENTITY_REFERENCE_NODE = 5;
119
120   /**
121    * The node is an <code>Entity</code>.
122    */
123   public static final short ENTITY_NODE = 6;
124
125   /**
126    * The node is a <code>ProcessingInstruction</code>.
127    */
128   public static final short PROCESSING_INSTRUCTION_NODE = 7;
129
130   /**
131    * The node is a <code>Comment</code>.
132    */
133   public static final short COMMENT_NODE = 8;
134
135   /**
136    * The node is a <code>Document</code>.
137    */
138   public static final short DOCUMENT_NODE = 9;
139
140   /**
141    * The node is a <code>DocumentType</code>.
142    */
143   public static final short DOCUMENT_TYPE_NODE = 10;
144
145   /**
146    * The node is a <code>DocumentFragment</code>.
147    */
148   public static final short DOCUMENT_FRAGMENT_NODE = 11;
149
150   /**
151    * The node is a <code>Notation</code>.
152    */
153   public static final short NOTATION_NODE = 12;
154
155   /**
156    * The node is a <code>namespace node</code>. Note that this is not
157    * currently a node type defined by the DOM API.
158    */
159   public static final short NAMESPACE_NODE = 13;
160   
161   /**
162    * The number of valid nodetypes.
163    */
164   public static final short NTYPES = 14;
165
166   // ========= DTM Implementation Control Functions. ==============
167 // %TBD% RETIRED -- do via setFeature if needed. Remove from impls.
168 // public void setParseBlockSize(int blockSizeSuggestion);
169
170   /**
171    * Set an implementation dependent feature.
172    * <p>
173    * %REVIEW% Do we really expect to set features on DTMs?
174    *
175    * @param featureId A feature URL.
176    * @param state true if this feature should be on, false otherwise.
177    */
178   public void setFeature(String featureId, boolean state);
179
180   /**
181    * Set a run time property for this DTM instance.
182    *
183    * @param property a <code>String</code> value
184    * @param value an <code>Object</code> value
185    */
186   public void setProperty(String property, Object value);
187
188   // ========= Document Navigation Functions =========
189
190   /**
191    * This returns a stateless "traverser", that can navigate over an
192    * XPath axis, though not in document order.
193    *
194    * @param axis One of Axes.ANCESTORORSELF, etc.
195    *
196    * @return A DTMAxisIterator, or null if the givin axis isn't supported.
197    */
198   public DTMAxisTraverser getAxisTraverser(final int axis);
199
200   /**
201    * This is a shortcut to the iterators that implement
202    * XPath axes.
203    * Returns a bare-bones iterator that must be initialized
204    * with a start node (using iterator.setStartNode()).
205    *
206    * @param axis One of Axes.ANCESTORORSELF, etc.
207    *
208    * @return A DTMAxisIterator, or null if the givin axis isn't supported.
209    */
210   public DTMAxisIterator getAxisIterator(final int axis);
211
212   /**
213    * Get an iterator that can navigate over an XPath Axis, predicated by
214    * the extended type ID.
215    *
216    * @param axis
217    * @param type An extended type ID.
218    *
219    * @return A DTMAxisIterator, or null if the givin axis isn't supported.
220    */
221   public DTMAxisIterator getTypedAxisIterator(final int axis, final int type);
222
223   /**
224    * Given a node handle, test if it has child nodes.
225    * <p> %REVIEW% This is obviously useful at the DOM layer, where it
226    * would permit testing this without having to create a proxy
227    * node. It's less useful in the DTM API, where
228    * (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and
229    * almost as self-evident. But it's a convenience, and eases porting
230    * of DOM code to DTM. </p>
231    *
232    * @param nodeHandle int Handle of the node.
233    * @return int true if the given node has child nodes.
234    */
235   public boolean hasChildNodes(int nodeHandle);
236
237   /**
238    * Given a node handle, get the handle of the node's first child.
239    *
240    * @param nodeHandle int Handle of the node.
241    * @return int DTM node-number of first child,
242    * or DTM.NULL to indicate none exists.
243    */
244   public int getFirstChild(int nodeHandle);
245
246   /**
247    * Given a node handle, get the handle of the node's last child.
248    *
249    * @param nodeHandle int Handle of the node.
250    * @return int Node-number of last child,
251    * or DTM.NULL to indicate none exists.
252    */
253   public int getLastChild(int nodeHandle);
254
255   /**
256    * Retrieves an attribute node by local name and namespace URI
257    *
258    * %TBD% Note that we currently have no way to support
259    * the DOM's old getAttribute() call, which accesses only the qname.
260    *
261    * @param elementHandle Handle of the node upon which to look up this attribute.
262    * @param namespaceURI The namespace URI of the attribute to
263    * retrieve, or null.
264    * @param name The local name of the attribute to
265    * retrieve.
266    * @return The attribute node handle with the specified name (
267    * <code>nodeName</code>) or <code>DTM.NULL</code> if there is no such
268    * attribute.
269    */
270   public int getAttributeNode(int elementHandle, String namespaceURI,
271                               String name);
272
273   /**
274    * Given a node handle, get the index of the node's first attribute.
275    *
276    * @param nodeHandle int Handle of the node.
277    * @return Handle of first attribute, or DTM.NULL to indicate none exists.
278    */
279   public int getFirstAttribute(int nodeHandle);
280
281   /**
282    * Given a node handle, get the index of the node's first namespace node.
283    *
284    * @param nodeHandle handle to node, which should probably be an element
285    * node, but need not be.
286    *
287    * @param inScope true if all namespaces in scope should be
288    * returned, false if only the node's own
289    * namespace declarations should be returned.
290    * @return handle of first namespace,
291    * or DTM.NULL to indicate none exists.
292    */
293   public int getFirstNamespaceNode(int nodeHandle, boolean inScope);
294
295   /**
296    * Given a node handle, advance to its next sibling.
297    * @param nodeHandle int Handle of the node.
298    * @return int Node-number of next sibling,
299    * or DTM.NULL to indicate none exists.
300    */
301   public int getNextSibling(int nodeHandle);
302
303   /**
304    * Given a node handle, find its preceeding sibling.
305    * WARNING: DTM implementations may be asymmetric; in some,
306    * this operation has been resolved by search, and is relatively expensive.
307    *
308    * @param nodeHandle the id of the node.
309    * @return int Node-number of the previous sib,
310    * or DTM.NULL to indicate none exists.
311    */
312   public int getPreviousSibling(int nodeHandle);
313
314   /**
315    * Given a node handle, advance to the next attribute. If an
316    * element, we advance to its first attribute; if an attr, we advance to
317    * the next attr of the same element.
318    *
319    * @param nodeHandle int Handle of the node.
320    * @return int DTM node-number of the resolved attr,
321    * or DTM.NULL to indicate none exists.
322    */
323   public int getNextAttribute(int nodeHandle);
324
325   /**
326    * Given a namespace handle, advance to the next namespace in the same scope
327    * (local or local-plus-inherited, as selected by getFirstNamespaceNode)
328    *
329    * @param baseHandle handle to original node from where the first child
330    * was relative to (needed to return nodes in document order).
331    * @param namespaceHandle handle to node which must be of type
332    * NAMESPACE_NODE.
333    * NEEDSDOC @param inScope
334    * @return handle of next namespace,
335    * or DTM.NULL to indicate none exists.
336    */
337   public int getNextNamespaceNode(int baseHandle, int namespaceHandle,
338                                   boolean inScope);
339
340   /**
341    * Given a node handle, find its parent node.
342    *
343    * @param nodeHandle the id of the node.
344    * @return int Node handle of parent,
345    * or DTM.NULL to indicate none exists.
346    */
347   public int getParent(int nodeHandle);
348
349   /**
350    * Given a DTM which contains only a single document,
351    * find the Node Handle of the Document node. Note
352    * that if the DTM is configured so it can contain multiple
353    * documents, this call will return the Document currently
354    * under construction -- but may return null if it's between
355    * documents. Generally, you should use getOwnerDocument(nodeHandle)
356    * or getDocumentRoot(nodeHandle) instead.
357    *
358    * @return int Node handle of document, or DTM.NULL if a shared DTM
359    * can not tell us which Document is currently active.
360    */
361   public int getDocument();
362
363   /**
364    * Given a node handle, find the owning document node. This version mimics
365    * the behavior of the DOM call by the same name.
366    *
367    * @param nodeHandle the id of the node.
368    * @return int Node handle of owning document, or DTM.NULL if the node was
369    * a Document.
370    * @see getDocumentRoot(int nodeHandle)
371    */
372   public int getOwnerDocument(int nodeHandle);
373
374   /**
375    * Given a node handle, find the owning document node.
376    *
377    * @param nodeHandle the id of the node.
378    * @return int Node handle of owning document, or the node itself if it was
379    * a Document. (Note difference from DOM, where getOwnerDocument returns
380    * null for the Document node.)
381    * @see getOwnerDocument(int nodeHandle)
382    */
383   public int getDocumentRoot(int nodeHandle);
384
385   /**
386    * Get the string-value of a node as a String object
387    * (see http://www.w3.org/TR/xpath#data-model
388    * for the definition of a node's string-value).
389    *
390    * @param nodeHandle The node ID.
391    *
392    * @return A string object that represents the string-value of the given node.
393    */
394   public XMLString getStringValue(int nodeHandle);
395
396   /**
397    * Get number of character array chunks in
398    * the string-value of a node.
399    * (see http://www.w3.org/TR/xpath#data-model
400    * for the definition of a node's string-value).
401    * Note that a single text node may have multiple text chunks.
402    *
403    * @param nodeHandle The node ID.
404    *
405    * @return number of character array chunks in
406    * the string-value of a node.
407    */
408   public int getStringValueChunkCount(int nodeHandle);
409
410   /**
411    * Get a character array chunk in the string-value of a node.
412    * (see http://www.w3.org/TR/xpath#data-model
413    * for the definition of a node's string-value).
414    * Note that a single text node may have multiple text chunks.
415    *
416    * @param nodeHandle The node ID.
417    * @param chunkIndex Which chunk to get.
418    * @param startAndLen A two-integer array which, upon return, WILL
419    * BE FILLED with values representing the chunk's start position
420    * within the returned character buffer and the length of the chunk.
421    * @return The character array buffer within which the chunk occurs,
422    * setting startAndLen's contents as a side-effect.
423    */
424   public char[] getStringValueChunk(int nodeHandle, int chunkIndex,
425                                     int[] startAndLen);
426
427   /**
428    * Given a node handle, return an ID that represents the node's expanded name.
429    *
430    * @param nodeHandle The handle to the node in question.
431    *
432    * @return the expanded-name id of the node.
433    */
434   public int getExpandedTypeID(int nodeHandle);
435
436   /**
437    * Given an expanded name, return an ID. If the expanded-name does not
438    * exist in the internal tables, the entry will be created, and the ID will
439    * be returned. Any additional nodes that are created that have this
440    * expanded name will use this ID.
441    *
442    * @param nodeHandle The handle to the node in question.
443    *
444    * NEEDSDOC @param namespace
445    * NEEDSDOC @param localName
446    * NEEDSDOC @param type
447    *
448    * @return the expanded-name id of the node.
449    */
450   public int getExpandedTypeID(String namespace, String localName, int type);
451
452   /**
453    * Given an expanded-name ID, return the local name part.
454    *
455    * @param ExpandedNameID an ID that represents an expanded-name.
456    * @return String Local name of this node.
457    */
458   public String getLocalNameFromExpandedNameID(int ExpandedNameID);
459
460   /**
461    * Given an expanded-name ID, return the namespace URI part.
462    *
463    * @param ExpandedNameID an ID that represents an expanded-name.
464    * @return String URI value of this node's namespace, or null if no
465    * namespace was resolved.
466    */
467   public String getNamespaceFromExpandedNameID(int ExpandedNameID);
468
469   /**
470    * Given a node handle, return its DOM-style node name. This will
471    * include names such as #text or #document.
472    *
473    * @param nodeHandle the id of the node.
474    * @return String Name of this node, which may be an empty string.
475    * %REVIEW% Document when empty string is possible...
476    */
477   public String getNodeName(int nodeHandle);
478
479   /**
480    * Given a node handle, return the XPath node name. This should be
481    * the name as described by the XPath data model, NOT the DOM-style
482    * name.
483    *
484    * @param nodeHandle the id of the node.
485    * @return String Name of this node.
486    */
487   public String getNodeNameX(int nodeHandle);
488
489   /**
490    * Given a node handle, return its DOM-style localname.
491    * (As defined in Namespaces, this is the portion of the name after the
492    * prefix, if present, or the whole node name if no prefix exists)
493    *
494    * @param nodeHandle the id of the node.
495    * @return String Local name of this node.
496    */
497   public String getLocalName(int nodeHandle);
498
499   /**
500    * Given a namespace handle, return the prefix that the namespace decl is
501    * mapping.
502    * Given a node handle, return the prefix used to map to the namespace.
503    * (As defined in Namespaces, this is the portion of the name before any
504    * colon character).
505    * @param postition int Handle of the node.
506    *
507    * <p> %REVIEW% Are you sure you want "" for no prefix? </p>
508    *
509    * @param nodeHandle the id of the node.
510    * @return String prefix of this node's name, or "" if no explicit
511    * namespace prefix was given.
512    */
513   public String getPrefix(int nodeHandle);
514
515   /**
516    * Given a node handle, return its DOM-style namespace URI
517    * (As defined in Namespaces, this is the declared URI which this node's
518    * prefix -- or default in lieu thereof -- was mapped to.)
519    * @param postition int Handle of the node.
520    *
521    * @param nodeHandle the id of the node.
522    * @return String URI value of this node's namespace, or null if no
523    * namespace was resolved.
524    */
525   public String getNamespaceURI(int nodeHandle);
526
527   /**
528    * Given a node handle, return its node value. This is mostly
529    * as defined by the DOM, but may ignore some conveniences.
530    * <p>
531    * @param nodeHandle The node id.
532    * @return String Value of this node, or null if not
533    * meaningful for this node type.
534    */
535   public String getNodeValue(int nodeHandle);
536
537   /**
538    * Given a node handle, return its DOM-style node type.
539    *
540    * <p>%REVIEW% Generally, returning short is false economy. Return int?</p>
541    *
542    * @param nodeHandle The node id.
543    * @return int Node type, as per the DOM's Node._NODE constants.
544    */
545   public short getNodeType(int nodeHandle);
546
547   /**
548    * Get the depth level of this node in the tree (equals 1 for
549    * a parentless node).
550    *
551    * @param nodeHandle The node id.
552    * @return the number of ancestors, plus one
553    * @xsl.usage internal
554    */
555   public short getLevel(int nodeHandle);
556
557   // ============== Document query functions ==============
558
559   /**
560    * Tests whether DTM DOM implementation implements a specific feature and
561    * that feature is supported by this node.
562    * @param feature The name of the feature to test.
563    * @param version This is the version number of the feature to test.
564    * If the version is not
565    * specified, supporting any version of the feature will cause the
566    * method to return <code>true</code>.
567    * @return Returns <code>true</code> if the specified feature is
568    * supported on this node, <code>false</code> otherwise.
569    */
570   public boolean isSupported(String feature, String version);
571
572   /**
573    * Return the base URI of the document entity. If it is not known
574    * (because the document was parsed from a socket connection or from
575    * standard input, for example), the value of this property is unknown.
576    *
577    * @return the document base URI String object or null if unknown.
578    */
579   public String getDocumentBaseURI();
580
581   /**
582    * Set the base URI of the document entity.
583    *
584    * @param baseURI the document base URI String object or null if unknown.
585    */
586   public void setDocumentBaseURI(String baseURI);
587
588   /**
589    * Return the system identifier of the document entity. If
590    * it is not known, the value of this property is null.
591    *
592    * @param nodeHandle The node id, which can be any valid node handle.
593    * @return the system identifier String object or null if unknown.
594    */
595   public String getDocumentSystemIdentifier(int nodeHandle);
596
597   /**
598    * Return the name of the character encoding scheme
599    * in which the document entity is expressed.
600    *
601    * @param nodeHandle The node id, which can be any valid node handle.
602    * @return the document encoding String object.
603    */
604   public String getDocumentEncoding(int nodeHandle);
605
606   /**
607    * Return an indication of the standalone status of the document,
608    * either "yes" or "no". This property is derived from the optional
609    * standalone document declaration in the XML declaration at the
610    * beginning of the document entity, and has no value if there is no
611    * standalone document declaration.
612    *
613    * @param nodeHandle The node id, which can be any valid node handle.
614    * @return the document standalone String object, either "yes", "no", or null.
615    */
616   public String getDocumentStandalone(int nodeHandle);
617
618   /**
619    * Return a string representing the XML version of the document. This
620    * property is derived from the XML declaration optionally present at the
621    * beginning of the document entity, and has no value if there is no XML
622    * declaration.
623    *
624    * @param the document handle
625    *
626    * NEEDSDOC @param documentHandle
627    *
628    * @return the document version String object
629    */
630   public String getDocumentVersion(int documentHandle);
631
632   /**
633    * Return an indication of
634    * whether the processor has read the complete DTD. Its value is a
635    * boolean. If it is false, then certain properties (indicated in their
636    * descriptions below) may be unknown. If it is true, those properties
637    * are never unknown.
638    *
639    * @return <code>true</code> if all declarations were processed;
640    * <code>false</code> otherwise.
641    */
642   public boolean getDocumentAllDeclarationsProcessed();
643
644   /**
645    * A document type declaration information item has the following properties:
646    *
647    * 1. [system identifier] The system identifier of the external subset, if
648    * it exists. Otherwise this property has no value.
649    *
650    * @return the system identifier String object, or null if there is none.
651    */
652   public String getDocumentTypeDeclarationSystemIdentifier();
653
654   /**
655    * Return the public identifier of the external subset,
656    * normalized as described in 4.2.2 External Entities [XML]. If there is
657    * no external subset or if it has no public identifier, this property
658    * has no value.
659    *
660    * @param the document type declaration handle
661    *
662    * @return the public identifier String object, or null if there is none.
663    */
664   public String getDocumentTypeDeclarationPublicIdentifier();
665
666   /**
667    * Returns the <code>Element</code> whose <code>ID</code> is given by
668    * <code>elementId</code>. If no such element exists, returns
669    * <code>DTM.NULL</code>. Behavior is not defined if more than one element
670    * has this <code>ID</code>. Attributes (including those
671    * with the name "ID") are not of type ID unless so defined by DTD/Schema
672    * information available to the DTM implementation.
673    * Implementations that do not know whether attributes are of type ID or
674    * not are expected to return <code>DTM.NULL</code>.
675    *
676    * <p>%REVIEW% Presumably IDs are still scoped to a single document,
677    * and this operation searches only within a single document, right?
678    * Wouldn't want collisions between DTMs in the same process.</p>
679    *
680    * @param elementId The unique <code>id</code> value for an element.
681    * @return The handle of the matching element.
682    */
683   public int getElementById(String elementId);
684
685   /**
686    * The getUnparsedEntityURI function returns the URI of the unparsed
687    * entity with the specified name in the same document as the context
688    * node (see [3.3 Unparsed Entities]). It returns the empty string if
689    * there is no such entity.
690    * <p>
691    * XML processors may choose to use the System Identifier (if one
692    * is provided) to resolve the entity, rather than the URI in the
693    * Public Identifier. The details are dependent on the processor, and
694    * we would have to support some form of plug-in resolver to handle
695    * this properly. Currently, we simply return the System Identifier if
696    * present, and hope that it a usable URI or that our caller can
697    * map it to one.
698    * %REVIEW% Resolve Public Identifiers... or consider changing function name.
699    * <p>
700    * If we find a relative URI
701    * reference, XML expects it to be resolved in terms of the base URI
702    * of the document. The DOM doesn't do that for us, and it isn't
703    * entirely clear whether that should be done here; currently that's
704    * pushed up to a higher level of our application. (Note that DOM Level
705    * 1 didn't store the document's base URI.)
706    * %REVIEW% Consider resolving Relative URIs.
707    * <p>
708    * (The DOM's statement that "An XML processor may choose to
709    * completely expand entities before the structure model is passed
710    * to the DOM" refers only to parsed entities, not unparsed, and hence
711    * doesn't affect this function.)
712    *
713    * @param name A string containing the Entity Name of the unparsed
714    * entity.
715    *
716    * @return String containing the URI of the Unparsed Entity, or an
717    * empty string if no such entity exists.
718    */
719   public String getUnparsedEntityURI(String name);
720
721   // ============== Boolean methods ================
722
723   /**
724    * Return true if the xsl:strip-space or xsl:preserve-space was processed
725    * during construction of the document contained in this DTM.
726    *
727    * NEEDSDOC ($objectName$) @return
728    */
729   public boolean supportsPreStripping();
730
731   /**
732    * Figure out whether nodeHandle2 should be considered as being later
733    * in the document than nodeHandle1, in Document Order as defined
734    * by the XPath model. This may not agree with the ordering defined
735    * by other XML applications.
736    * <p>
737    * There are some cases where ordering isn't defined, and neither are
738    * the results of this function -- though we'll generally return true.
739    * <p>
740    * %REVIEW% Make sure this does the right thing with attribute nodes!!!
741    * <p>
742    * %REVIEW% Consider renaming for clarity. Perhaps isDocumentOrder(a,b)?
743    *
744    * @param firstNodeHandle DOM Node to perform position comparison on.
745    * @param secondNodeHandle DOM Node to perform position comparison on.
746    *
747    * @return false if secondNode comes before firstNode, otherwise return true.
748    * You can think of this as
749    * <code>(firstNode.documentOrderPosition &lt;= secondNode.documentOrderPosition)</code>.
750    */
751   public boolean isNodeAfter(int firstNodeHandle, int secondNodeHandle);
752
753   /**
754    * 2. [element content whitespace] A boolean indicating whether a
755    * text node represents white space appearing within element content
756    * (see [XML], 2.10 "White Space Handling"). Note that validating
757    * XML processors are required by XML 1.0 to provide this
758    * information... but that DOM Level 2 did not support it, since it
759    * depends on knowledge of the DTD which DOM2 could not guarantee
760    * would be available.
761    * <p>
762    * If there is no declaration for the containing element, an XML
763    * processor must assume that the whitespace could be meaningful and
764    * return false. If no declaration has been read, but the [all
765    * declarations processed] property of the document information item
766    * is false (so there may be an unread declaration), then the value
767    * of this property is indeterminate for white space characters and
768    * should probably be reported as false. It is always false for text
769    * nodes that contain anything other than (or in addition to) white
770    * space.
771    * <p>
772    * Note too that it always returns false for non-Text nodes.
773    * <p>
774    * %REVIEW% Joe wants to rename this isWhitespaceInElementContent() for clarity
775    *
776    * @param nodeHandle the node ID.
777    * @return <code>true</code> if the node definitely represents whitespace in
778    * element content; <code>false</code> otherwise.
779    */
780   public boolean isCharacterElementContentWhitespace(int nodeHandle);
781
782   /**
783    * 10. [all declarations processed] This property is not strictly speaking
784    * part of the infoset of the document. Rather it is an indication of
785    * whether the processor has read the complete DTD. Its value is a
786    * boolean. If it is false, then certain properties (indicated in their
787    * descriptions below) may be unknown. If it is true, those properties
788    * are never unknown.
789    *
790    *
791    * @param the document handle
792    *
793    * @param documentHandle A node handle that must identify a document.
794    * @return <code>true</code> if all declarations were processed;
795    * <code>false</code> otherwise.
796    */
797   public boolean isDocumentAllDeclarationsProcessed(int documentHandle);
798
799   /**
800    * 5. [specified] A flag indicating whether this attribute was actually
801    * specified in the start-tag of its element, or was defaulted from the
802    * DTD (or schema).
803    *
804    * @param the attribute handle
805    *
806    * NEEDSDOC @param attributeHandle
807    * @return <code>true</code> if the attribute was specified;
808    * <code>false</code> if it was defaulted or the handle doesn't
809    * refer to an attribute node.
810    */
811   public boolean isAttributeSpecified(int attributeHandle);
812
813   // ========== Direct SAX Dispatch, for optimization purposes ========
814
815   /**
816    * Directly call the
817    * characters method on the passed ContentHandler for the
818    * string-value of the given node (see http://www.w3.org/TR/xpath#data-model
819    * for the definition of a node's string-value). Multiple calls to the
820    * ContentHandler's characters methods may well occur for a single call to
821    * this method.
822    *
823    * @param nodeHandle The node ID.
824    * @param ch A non-null reference to a ContentHandler.
825    * @param normalize true if the content should be normalized according to
826    * the rules for the XPath
827    * <a HREF="http://www.w3.org/TR/xpath#function-normalize-space">normalize-space</a>
828    * function.
829    *
830    * @throws org.xml.sax.SAXException
831    */
832   public void dispatchCharactersEvents(
833     int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize)
834       throws org.xml.sax.SAXException ;
835
836   /**
837    * Directly create SAX parser events representing the XML content of
838    * a DTM subtree. This is a "serialize" operation.
839    *
840    * @param nodeHandle The node ID.
841    * @param ch A non-null reference to a ContentHandler.
842    *
843    * @throws org.xml.sax.SAXException
844    */
845   public void dispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch)
846     throws org.xml.sax.SAXException ;
847
848   /**
849    * Return an DOM node for the given node.
850    *
851    * @param nodeHandle The node ID.
852    *
853    * @return A node representation of the DTM node.
854    */
855   public org.w3c.dom.Node getNode(int nodeHandle);
856
857   // ==== Construction methods (may not be supported by some implementations!) =====
858 // %REVIEW% What response occurs if not supported?
859
860   /**
861    * @return true iff we're building this model incrementally (eg
862    * we're partnered with a CoroutineParser) and thus require that the
863    * transformation and the parse run simultaneously. Guidance to the
864    * DTMManager.
865    */
866   public boolean needsTwoThreads();
867
868   // %REVIEW% Do these appends make any sense, should we support a
869 // wider set of methods (like the "append" methods in the
870 // current DTMDocumentImpl draft), or should we just support SAX
871 // listener interfaces? Should it be a separate interface to
872 // make that distinction explicit?
873
874   /**
875    * Return this DTM's content handler, if it has one.
876    *
877    * @return null if this model doesn't respond to SAX events.
878    */
879   public org.xml.sax.ContentHandler getContentHandler();
880
881   /**
882    * Return this DTM's lexical handler, if it has one.
883    *
884    * %REVIEW% Should this return null if constrution already done/begun?
885    *
886    * @return null if this model doesn't respond to lexical SAX events.
887    */
888   public org.xml.sax.ext.LexicalHandler getLexicalHandler();
889
890   /**
891    * Return this DTM's EntityResolver, if it has one.
892    *
893    * @return null if this model doesn't respond to SAX entity ref events.
894    */
895   public org.xml.sax.EntityResolver getEntityResolver();
896
897   /**
898    * Return this DTM's DTDHandler, if it has one.
899    *
900    * @return null if this model doesn't respond to SAX dtd events.
901    */
902   public org.xml.sax.DTDHandler getDTDHandler();
903
904   /**
905    * Return this DTM's ErrorHandler, if it has one.
906    *
907    * @return null if this model doesn't respond to SAX error events.
908    */
909   public org.xml.sax.ErrorHandler getErrorHandler();
910
911   /**
912    * Return this DTM's DeclHandler, if it has one.
913    *
914    * @return null if this model doesn't respond to SAX Decl events.
915    */
916   public org.xml.sax.ext.DeclHandler getDeclHandler();
917
918   /**
919    * Append a child to "the end of the document". Please note that
920    * the node is always cloned in a base DTM, since our basic behavior
921    * is immutable so nodes can't be removed from their previous
922    * location.
923    *
924    * <p> %REVIEW% DTM maintains an insertion cursor which
925    * performs a depth-first tree walk as nodes come in, and this operation
926    * is really equivalent to:
927    * insertionCursor.appendChild(document.importNode(newChild)))
928    * where the insert point is the last element that was appended (or
929    * the last one popped back to by an end-element operation).</p>
930    *
931    * @param newChild Must be a valid new node handle.
932    * @param clone true if the child should be cloned into the document.
933    * @param cloneDepth if the clone argument is true, specifies that the
934    * clone should include all it's children.
935    */
936   public void appendChild(int newChild, boolean clone, boolean cloneDepth);
937
938   /**
939    * Append a text node child that will be constructed from a string,
940    * to the end of the document. Behavior is otherwise like appendChild().
941    *
942    * @param str Non-null reference to a string.
943    */
944   public void appendTextChild(String str);
945
946   /**
947    * Get the location of a node in the source document.
948    *
949    * @param node an <code>int</code> value
950    * @return a <code>SourceLocator</code> value or null if no location
951    * is available
952    */
953   public SourceLocator getSourceLocatorFor(int node);
954
955   /**
956    * As the DTM is registered with the DTMManager, this method
957    * will be called. This will give the DTM implementation a
958    * chance to initialize any subsystems that are required to
959    * build the DTM
960    */
961   public void documentRegistration();
962
963   /**
964    * As documents are released from the DTMManager, the DTM implementation
965    * will be notified of the event. This will allow the DTM implementation
966    * to shutdown any subsystem activity that may of been assoiated with
967    * the active DTM Implementation.
968    */
969
970    public void documentRelease();
971
972    /**
973     * Migrate a DTM built with an old DTMManager to a new DTMManager.
974     * After the migration, the new DTMManager will treat the DTM as
975     * one that is built by itself.
976     * This is used to support DTM sharing between multiple transformations.
977     * @param manager the DTMManager
978     */
979    public void migrateTo(DTMManager manager);
980 }
981

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags