Java Doc for DTMDefaultBase.java in  » XML » xalan » org » apache » xml » dtm » ref » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xalan » org.apache.xml.dtm.ref 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xml.dtm.ref.DTMDefaultBase

All known Subclasses:   org.apache.xml.dtm.ref.DTMDefaultBaseTraversers,
DTMDefaultBase
abstract public class DTMDefaultBase implements DTM(Code)
The DTMDefaultBase class serves as a helper base for DTMs. It sets up structures for navigation and type, while leaving data management and construction to the derived classes.


Field Summary
final public static  intDEFAULT_BLOCKSIZE
    
final public static  intDEFAULT_NUMBLOCKS
    
final public static  intDEFAULT_NUMBLOCKS_SMALL
    
final static  booleanJJK_DEBUG
    
final protected static  intNOTPROCESSED
     The value to use when the information has not been built yet.
final public static  intROOTNODE
     The identity of the root node.
protected  Stringm_documentBaseURI
     The base URI for this document.
protected  SuballocatedIntVectorm_dtmIdent
     The document identity number(s).
protected  int[][][]m_elemIndexes
     These hold indexes to elements based on namespace and local name. The base lookup is the the namespace.
protected  ExpandedNameTablem_expandedNameTable
     The table for exandedNameID lookups.
protected  SuballocatedIntVectorm_exptype
     The expanded names, one array element for each node.
protected  SuballocatedIntVectorm_firstch
     First child values, one array element for each node.
protected  booleanm_indexing
     true if indexing is turned on.
public  DTMManagerm_mgr
     The DTM manager who "owns" this DTM.
protected  DTMManagerDefaultm_mgrDefault
    
protected  SuballocatedIntVectorm_namespaceDeclSetElements
    
protected  Vectorm_namespaceDeclSets
    
protected  SuballocatedIntVectorm_nextsib
     Next sibling values, one array element for each node.
protected  SuballocatedIntVectorm_parent
     Previous sibling values, one array element for each node.
protected  SuballocatedIntVectorm_prevsib
     Previous sibling values, one array element for each node.
protected  booleanm_shouldStripWS
    
protected  BoolStackm_shouldStripWhitespaceStack
    
protected  intm_size
     The number of nodes, which is also used to determine the next node index.
protected  DTMAxisTraverser[]m_traversers
     Stateless axis traversers, lazely built.
protected  DTMWSFilterm_wsfilter
     The whitespace filter that enables elements to strip whitespace or not.
protected  XMLStringFactorym_xstrf
     The XMLString factory for creating XMLStrings.

Constructor Summary
public  DTMDefaultBase(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)
     Construct a DTMDefaultBase object using the default block size.
public  DTMDefaultBase(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing, int blocksize, boolean usePrevsib, boolean newNameTable)
     Construct a DTMDefaultBase object from a DOM node.

Method Summary
protected  int_exptype(int identity)
     Get the expanded type ID for the given node identity.
Parameters:
  identity - The node identity.
protected  int_firstch(int identity)
     Get the first child for the given node identity.
Parameters:
  identity - The node identity.
protected  int_level(int identity)
     Get the level in the tree for the given node identity.
Parameters:
  identity - The node identity.
protected  int_nextsib(int identity)
     Get the next sibling for the given node identity.
Parameters:
  identity - The node identity.
protected  int_parent(int identity)
     Get the parent for the given node identity.
Parameters:
  identity - The node identity.
protected  int_prevsib(int identity)
     Get the previous sibling for the given node identity.
Parameters:
  identity - The node identity.
protected  short_type(int identity)
     Get the simple type ID for the given node identity.
Parameters:
  identity - The node identity.
public  voidappendChild(int newChild, boolean clone, boolean cloneDepth)
     Append a child to the end of the document.
public  voidappendTextChild(String str)
     Append a text node child that will be constructed from a string, to the end of the document.
protected  voiddeclareNamespaceInContext(int elementNodeIndex, int namespaceNodeIndex)
     Build table of namespace declaration locations during DTM construction.
abstract public  voiddispatchCharactersEvents(int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize)
     Directly call the characters method on the passed ContentHandler for the string-value of the given node (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
abstract public  voiddispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch)
     Directly create SAX parser events from a subtree.
public  voiddocumentRegistration()
     A dummy routine to satisify the abstract interface.
public  voiddocumentRelease()
     A dummy routine to satisify the abstract interface.
public  voiddumpDTM(OutputStream os)
     Diagnostics function to dump the DTM.
public  StringdumpNode(int nodeHandle)
     Diagnostics function to dump a single node. %REVIEW% KNOWN GLITCH: If you pass it a node index rather than a node handle, it works just fine...
protected  voidensureSizeOfIndex(int namespaceID, int LocalNameID)
     Ensure that the size of the element indexes can hold the information.
protected  voiderror(String msg)
     Simple error for asserts and the like.
 intfindElementFromIndex(int nsIndex, int lnIndex, int firstPotential)
     Find the first matching element from the index at or after the given node.
Parameters:
  nsIndex - The namespace index lookup.
Parameters:
  lnIndex - The local name index lookup.
Parameters:
  firstPotential - The first potential match that is worth looking at.
protected  intfindGTE(int[] list, int start, int len, int value)
     Find the first index that occurs in the list that is greater than or equal to the given value.
Parameters:
  list - A list of integers.
Parameters:
  start - The start index to begin the search.
Parameters:
  len - The number of items to search.
Parameters:
  value - Find the slot that has a value that is greater than oridentical to this argument.
protected  intfindInSortedSuballocatedIntVector(SuballocatedIntVector vector, int lookfor)
     Subroutine: Locate the specified node within m_namespaceDeclSetElements, or the last element which preceeds it in document order %REVIEW% Inlne this into findNamespaceContext? Create SortedSuballocatedIntVector type? If positive or zero, the index of the found item.If negative, index of the point at which it would have appeared,encoded as -1-index and hence reconvertable by subtractingit from -1.
protected  SuballocatedIntVectorfindNamespaceContext(int elementNodeIndex)
     Retrieve list of namespace declaration locations active at this node.
abstract public  intgetAttributeNode(int nodeHandle, String namespaceURI, String name)
     Retrieves an attribute node by by qualified name and namespace URI.
Parameters:
  nodeHandle - int Handle of the node upon which to look up this attribute..
Parameters:
  namespaceURI - The namespace URI of the attribute toretrieve, or null.
Parameters:
  name - The local name of the attribute toretrieve.
public  SuballocatedIntVectorgetDTMIDs()
     Query which DTMIDs this DTM is currently using within the DTMManager.
public  intgetDocument()
     Find the Document node handle for the document currently under construction.
public  booleangetDocumentAllDeclarationsProcessed()
     Return an indication of whether the processor has read the complete DTD.
public  StringgetDocumentBaseURI()
     Return the base URI of the document entity.
public  StringgetDocumentEncoding(int nodeHandle)
     Return the name of the character encoding scheme in which the document entity is expressed.
Parameters:
  nodeHandle - The node id, which can be any valid node handle.
public  intgetDocumentRoot(int nodeHandle)
     Given a node handle, find the owning document node.
public  StringgetDocumentStandalone(int nodeHandle)
     Return an indication of the standalone status of the document, either "yes" or "no".
public  StringgetDocumentSystemIdentifier(int nodeHandle)
     Return the system identifier of the document entity.
abstract public  StringgetDocumentTypeDeclarationPublicIdentifier()
     Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML].
abstract public  StringgetDocumentTypeDeclarationSystemIdentifier()
     A document type declaration information item has the following properties: 1.
public  StringgetDocumentVersion(int documentHandle)
     Return a string representing the XML version of the document.
abstract public  intgetElementById(String elementId)
     Returns the Element whose ID is given by elementId.
public  intgetExpandedTypeID(int nodeHandle)
     Given a node handle, return an ID that represents the node's expanded name.
Parameters:
  nodeHandle - The handle to the node in question.
public  intgetExpandedTypeID(String namespace, String localName, int type)
     Given an expanded name, return an ID.
public  intgetFirstAttribute(int nodeHandle)
     Given a node handle, get the index of the node's first attribute.
Parameters:
  nodeHandle - int Handle of the node.
protected  intgetFirstAttributeIdentity(int identity)
     Given a node identity, get the index of the node's first attribute.
Parameters:
  identity - int identity of the node.
public  intgetFirstChild(int nodeHandle)
     Given a node handle, get the handle of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node.
public  intgetFirstNamespaceNode(int nodeHandle, boolean inScope)
     Given a node handle, get the index of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again
Parameters:
  nodeHandle - handle to node, which should probably be an elementnode, but need not be.
Parameters:
  inScope - true if all namespaces in scope should be returned,false if only the namespace declarations should bereturned.
public  intgetLastChild(int nodeHandle)
     Given a node handle, advance to its last child. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node.
public  shortgetLevel(int nodeHandle)
     Get the depth level of this node in the tree (equals 1 for a parentless node).
Parameters:
  nodeHandle - The node id.
abstract public  StringgetLocalName(int nodeHandle)
     Given a node handle, return its XPath-style localname. (As defined in Namespaces, this is the portion of the name after any colon character).
Parameters:
  nodeHandle - the id of the node.
public  StringgetLocalNameFromExpandedNameID(int expandedNameID)
     Given an expanded-name ID, return the local name part.
Parameters:
  expandedNameID - an ID that represents an expanded-name.
public  DTMManagergetManager()
     Query which DTMManager this DTM is currently being handled by.
public  StringgetNamespaceFromExpandedNameID(int expandedNameID)
     Given an expanded-name ID, return the namespace URI part.
Parameters:
  expandedNameID - an ID that represents an expanded-name.
public  intgetNamespaceType(int nodeHandle)
     Returns the namespace type of a specific node
Parameters:
  nodeHandle - the id of the node.
abstract public  StringgetNamespaceURI(int nodeHandle)
     Given a node handle, return its DOM-style namespace URI (As defined in Namespaces, this is the declared URI which this node's prefix -- or default in lieu thereof -- was mapped to.)

%REVIEW% Null or ""? -sb


Parameters:
  nodeHandle - the id of the node.
public  intgetNextAttribute(int nodeHandle)
     Given a node handle, advance to the next attribute. If an attr, we advance to the next attr on the same node.
protected  intgetNextAttributeIdentity(int identity)
     Given a node identity for an attribute, advance to the next attribute.
Parameters:
  identity - int identity of the attribute node.
public  intgetNextNamespaceNode(int baseHandle, int nodeHandle, boolean inScope)
     Given a namespace handle, advance to the next namespace.
Parameters:
  baseHandle - handle to original node from where the first namespacewas relative to (needed to return nodes in document order).
Parameters:
  nodeHandle - A namespace handle for which we will find the next node.
Parameters:
  inScope - true if all namespaces that are in scope should be processed,otherwise just process the nodes in the given element handle.
abstract protected  intgetNextNodeIdentity(int identity)
     Get the next node identity value in the list, and call the iterator if it hasn't been added yet.
Parameters:
  identity - The node identity (index).
public  intgetNextSibling(int nodeHandle)
     Given a node handle, advance to its next sibling. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node.
public  org.w3c.dom.NodegetNode(int nodeHandle)
     Return an DOM node for the given node.
Parameters:
  nodeHandle - The node ID.
public  intgetNodeHandle(int nodeId)
     Get the handle of this node in the tree
Parameters:
  nodeId - The node identity.
public  intgetNodeIdent(int nodeHandle)
     Get the identity of this node in the tree
Parameters:
  nodeHandle - The node handle.
abstract public  StringgetNodeName(int nodeHandle)
     Given a node handle, return its DOM-style node name.
public  StringgetNodeNameX(int nodeHandle)
     Given a node handle, return the XPath node name.
public  shortgetNodeType(int nodeHandle)
     Given a node handle, return its DOM-style node type.

%REVIEW% Generally, returning short is false economy.

abstract public  StringgetNodeValue(int nodeHandle)
     Given a node handle, return its node value.
abstract protected  intgetNumberOfNodes()
     Get the number of nodes that have been added.
public  intgetOwnerDocument(int nodeHandle)
     Given a node handle, find the owning document node.
public  intgetParent(int nodeHandle)
     Given a node handle, find its parent node.
Parameters:
  nodeHandle - the id of the node.
abstract public  StringgetPrefix(int nodeHandle)
     Given a namespace handle, return the prefix that the namespace decl is mapping. Given a node handle, return the prefix used to map to the namespace.

%REVIEW% Are you sure you want "" for no prefix?

%REVIEW-COMMENT% I think so...

public  intgetPreviousSibling(int nodeHandle)
     Given a node handle, find its preceeding sibling. WARNING: DTM is asymmetric; this operation is resolved by search, and is relatively expensive.
Parameters:
  nodeHandle - the id of the node.
protected  booleangetShouldStripWhitespace()
     Find out whether or not to strip whispace nodes.
abstract public  XMLStringgetStringValue(int nodeHandle)
     Get the string-value of a node as a String object (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
Parameters:
  nodeHandle - The node ID.
public  char[]getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)
     Get a character array chunk in the string-value of a node. (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Note that a single text node may have multiple text chunks.
Parameters:
  nodeHandle - The node ID.
Parameters:
  chunkIndex - Which chunk to get.
Parameters:
  startAndLen - An array of 2 where the start position and length ofthe chunk will be returned.
public  intgetStringValueChunkCount(int nodeHandle)
     Get number of character array chunks in the string-value of a node. (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Note that a single text node may have multiple text chunks.
Parameters:
  nodeHandle - The node ID.
protected  intgetTypedAttribute(int nodeHandle, int attType)
     Given a node handle and an expanded type ID, get the index of the node's attribute of that type, if any.
Parameters:
  nodeHandle - int Handle of the node.
Parameters:
  attType - int expanded type ID of the required attribute.
public  intgetTypedFirstChild(int nodeHandle, int nodeType)
     Given a node handle, get the handle of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node.
public  intgetTypedNextSibling(int nodeHandle, int nodeType)
     Given a node handle, advance to its next sibling. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node.
abstract public  StringgetUnparsedEntityURI(String name)
     The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]).
public  booleanhasChildNodes(int nodeHandle)
     Given a node handle, test if it has child nodes.

%REVIEW% This is obviously useful at the DOM layer, where it would permit testing this without having to create a proxy node.

protected  voidindexNode(int expandedTypeID, int identity)
     Add a node to the element indexes.
abstract public  booleanisAttributeSpecified(int attributeHandle)
     5.
public  booleanisCharacterElementContentWhitespace(int nodeHandle)
     2.
public  booleanisDocumentAllDeclarationsProcessed(int documentHandle)
     10.
public  booleanisNodeAfter(int nodeHandle1, int nodeHandle2)
     Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model.
public  booleanisSupported(String feature, String version)
     Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node.
Parameters:
  feature - The name of the feature to test.
Parameters:
  version - This is the version number of the feature to test.If the version is notspecified, supporting any version of the feature will cause themethod to return true.
final public  intmakeNodeHandle(int nodeIdentity)
     Given a node identity, return a node handle.
final public  intmakeNodeIdentity(int nodeHandle)
     Given a node handle, return a node identity.
public  voidmigrateTo(DTMManager mgr)
     Migrate a DTM built with an old DTMManager to a new DTMManager.
abstract protected  booleannextNode()
     This method should try and build one or more nodes in the table.
protected  voidpopShouldStripWhitespace()
     Set whether to strip whitespaces at this point by popping out m_shouldStripWhitespaceStack.
protected  voidpushShouldStripWhitespace(boolean shouldStrip)
     Set whether to strip whitespaces and push in current value of m_shouldStripWS in m_shouldStripWhitespaceStack.
public  voidsetDocumentBaseURI(String baseURI)
     Set the base URI of the document entity.
public  voidsetFeature(String featureId, boolean state)
     Set an implementation dependent feature.
protected  voidsetShouldStripWhitespace(boolean shouldStrip)
     Set whether to strip whitespaces and set the top of the stack to the current value of m_shouldStripWS.
public  booleansupportsPreStripping()
     Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the DTM document.

Field Detail
DEFAULT_BLOCKSIZE
final public static int DEFAULT_BLOCKSIZE(Code)
The default block size of the node arrays



DEFAULT_NUMBLOCKS
final public static int DEFAULT_NUMBLOCKS(Code)
The number of blocks for the node arrays



DEFAULT_NUMBLOCKS_SMALL
final public static int DEFAULT_NUMBLOCKS_SMALL(Code)
The number of blocks used for small documents & RTFs



JJK_DEBUG
final static boolean JJK_DEBUG(Code)



NOTPROCESSED
final protected static int NOTPROCESSED(Code)
The value to use when the information has not been built yet.



ROOTNODE
final public static int ROOTNODE(Code)
The identity of the root node.



m_documentBaseURI
protected String m_documentBaseURI(Code)
The base URI for this document.



m_dtmIdent
protected SuballocatedIntVector m_dtmIdent(Code)
The document identity number(s). If we have overflowed the addressing range of the first that was assigned to us, we may add others.



m_elemIndexes
protected int[][][] m_elemIndexes(Code)
These hold indexes to elements based on namespace and local name. The base lookup is the the namespace. The second lookup is the local name, and the last array contains the the first free element at the start, and the list of element handles following.



m_expandedNameTable
protected ExpandedNameTable m_expandedNameTable(Code)
The table for exandedNameID lookups. This may or may not be the same table as is contained in the DTMManagerDefault.



m_exptype
protected SuballocatedIntVector m_exptype(Code)
The expanded names, one array element for each node.



m_firstch
protected SuballocatedIntVector m_firstch(Code)
First child values, one array element for each node.



m_indexing
protected boolean m_indexing(Code)
true if indexing is turned on.



m_mgr
public DTMManager m_mgr(Code)
The DTM manager who "owns" this DTM.



m_mgrDefault
protected DTMManagerDefault m_mgrDefault(Code)
m_mgr cast to DTMManagerDefault, or null if it isn't an instance (Efficiency hook)



m_namespaceDeclSetElements
protected SuballocatedIntVector m_namespaceDeclSetElements(Code)
SuballocatedIntVector of elements at which corresponding namespaceDeclSets were defined



m_namespaceDeclSets
protected Vector m_namespaceDeclSets(Code)
Vector of SuballocatedIntVectors of NS decl sets



m_nextsib
protected SuballocatedIntVector m_nextsib(Code)
Next sibling values, one array element for each node.



m_parent
protected SuballocatedIntVector m_parent(Code)
Previous sibling values, one array element for each node.



m_prevsib
protected SuballocatedIntVector m_prevsib(Code)
Previous sibling values, one array element for each node.



m_shouldStripWS
protected boolean m_shouldStripWS(Code)
Flag indicating whether to strip whitespace nodes



m_shouldStripWhitespaceStack
protected BoolStack m_shouldStripWhitespaceStack(Code)
Stack of flags indicating whether to strip whitespace nodes



m_size
protected int m_size(Code)
The number of nodes, which is also used to determine the next node index.



m_traversers
protected DTMAxisTraverser[] m_traversers(Code)
Stateless axis traversers, lazely built.



m_wsfilter
protected DTMWSFilter m_wsfilter(Code)
The whitespace filter that enables elements to strip whitespace or not.



m_xstrf
protected XMLStringFactory m_xstrf(Code)
The XMLString factory for creating XMLStrings.




Constructor Detail
DTMDefaultBase
public DTMDefaultBase(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)(Code)
Construct a DTMDefaultBase object using the default block size.
Parameters:
  mgr - The DTMManager who owns this DTM.
Parameters:
  source - The object that is used to specify the construction source.
Parameters:
  dtmIdentity - The DTM identity ID for this DTM.
Parameters:
  whiteSpaceFilter - The white space filter for this DTM, which maybe null.
Parameters:
  xstringfactory - The factory to use for creating XMLStrings.
Parameters:
  doIndexing - true if the caller considers it worth it to useindexing schemes.



DTMDefaultBase
public DTMDefaultBase(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing, int blocksize, boolean usePrevsib, boolean newNameTable)(Code)
Construct a DTMDefaultBase object from a DOM node.
Parameters:
  mgr - The DTMManager who owns this DTM.
Parameters:
  source - The object that is used to specify the construction source.
Parameters:
  dtmIdentity - The DTM identity ID for this DTM.
Parameters:
  whiteSpaceFilter - The white space filter for this DTM, which maybe null.
Parameters:
  xstringfactory - The factory to use for creating XMLStrings.
Parameters:
  doIndexing - true if the caller considers it worth it to useindexing schemes.
Parameters:
  blocksize - The block size of the DTM.
Parameters:
  usePrevsib - true if we want to build the previous sibling node array.
Parameters:
  newNameTable - true if we want to use a new ExpandedNameTable for this DTM.




Method Detail
_exptype
protected int _exptype(int identity)(Code)
Get the expanded type ID for the given node identity.
Parameters:
  identity - The node identity. The expanded type ID, or DTM.NULL.



_firstch
protected int _firstch(int identity)(Code)
Get the first child for the given node identity.
Parameters:
  identity - The node identity. The first child identity, or DTM.NULL.



_level
protected int _level(int identity)(Code)
Get the level in the tree for the given node identity.
Parameters:
  identity - The node identity. The tree level, or DTM.NULL.



_nextsib
protected int _nextsib(int identity)(Code)
Get the next sibling for the given node identity.
Parameters:
  identity - The node identity. The next sibling identity, or DTM.NULL.



_parent
protected int _parent(int identity)(Code)
Get the parent for the given node identity.
Parameters:
  identity - The node identity. The parent identity, or DTM.NULL.



_prevsib
protected int _prevsib(int identity)(Code)
Get the previous sibling for the given node identity.
Parameters:
  identity - The node identity. The previous sibling identity, or DTM.NULL.



_type
protected short _type(int identity)(Code)
Get the simple type ID for the given node identity.
Parameters:
  identity - The node identity. The simple type ID, or DTM.NULL.



appendChild
public void appendChild(int newChild, boolean clone, boolean cloneDepth)(Code)
Append a child to the end of the document. Please note that the node is always cloned if it is owned by another document.

%REVIEW% "End of the document" needs to be defined more clearly. Does it become the last child of the Document? Of the root element?


Parameters:
  newChild - Must be a valid new node handle.
Parameters:
  clone - true if the child should be cloned into the document.
Parameters:
  cloneDepth - if the clone argument is true, specifies that theclone should include all it's children.



appendTextChild
public void appendTextChild(String str)(Code)
Append a text node child that will be constructed from a string, to the end of the document.

%REVIEW% "End of the document" needs to be defined more clearly. Does it become the last child of the Document? Of the root element?


Parameters:
  str - Non-null reverence to a string.



declareNamespaceInContext
protected void declareNamespaceInContext(int elementNodeIndex, int namespaceNodeIndex)(Code)
Build table of namespace declaration locations during DTM construction. Table is a Vector of SuballocatedIntVectors containing the namespace node HANDLES declared at that ID, plus an SuballocatedIntVector of the element node INDEXES at which these declarations appeared. NOTE: Since this occurs during model build, nodes will be encountered in doucment order and thus the table will be ordered by element, permitting binary-search as a possible retrieval optimization. %REVIEW% Directly managed arrays rather than vectors? %REVIEW% Handles or IDs? Given usage, I think handles.



dispatchCharactersEvents
abstract public void dispatchCharactersEvents(int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize) throws org.xml.sax.SAXException(Code)
Directly call the characters method on the passed ContentHandler for the string-value of the given node (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Multiple calls to the ContentHandler's characters methods may well occur for a single call to this method.
Parameters:
  nodeHandle - The node ID.
Parameters:
  ch - A non-null reference to a ContentHandler.
Parameters:
  normalize - true if the content should be normalized according tothe rules for the XPathnormalize-spacefunction.
throws:
  org.xml.sax.SAXException -



dispatchToEvents
abstract public void dispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch) throws org.xml.sax.SAXException(Code)
Directly create SAX parser events from a subtree.
Parameters:
  nodeHandle - The node ID.
Parameters:
  ch - A non-null reference to a ContentHandler.
throws:
  org.xml.sax.SAXException -



documentRegistration
public void documentRegistration()(Code)
A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification of registration, they can override this method.



documentRelease
public void documentRelease()(Code)
A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification when the document is being released, they can override this method



dumpDTM
public void dumpDTM(OutputStream os)(Code)
Diagnostics function to dump the DTM.



dumpNode
public String dumpNode(int nodeHandle)(Code)
Diagnostics function to dump a single node. %REVIEW% KNOWN GLITCH: If you pass it a node index rather than a node handle, it works just fine... but the displayed identity number before the colon is different, which complicates comparing it with nodes printed the other way. We could always OR the DTM ID into the value, to suppress that distinction... %REVIEW% This might want to be moved up to DTMDefaultBase, or possibly DTM itself, since it's a useful diagnostic and uses only DTM's public APIs.



ensureSizeOfIndex
protected void ensureSizeOfIndex(int namespaceID, int LocalNameID)(Code)
Ensure that the size of the element indexes can hold the information.
Parameters:
  namespaceID - Namespace ID index.
Parameters:
  LocalNameID - Local name ID.



error
protected void error(String msg)(Code)
Simple error for asserts and the like.
Parameters:
  msg - Error message to report.



findElementFromIndex
int findElementFromIndex(int nsIndex, int lnIndex, int firstPotential)(Code)
Find the first matching element from the index at or after the given node.
Parameters:
  nsIndex - The namespace index lookup.
Parameters:
  lnIndex - The local name index lookup.
Parameters:
  firstPotential - The first potential match that is worth looking at. The first node that is greater than or equal to thefirstPotential argument, or DTM.NOTPROCESSED if not found.



findGTE
protected int findGTE(int[] list, int start, int len, int value)(Code)
Find the first index that occurs in the list that is greater than or equal to the given value.
Parameters:
  list - A list of integers.
Parameters:
  start - The start index to begin the search.
Parameters:
  len - The number of items to search.
Parameters:
  value - Find the slot that has a value that is greater than oridentical to this argument. The index in the list of the slot that is higher or identicalto the identity argument, or -1 if no node is higher or equal.



findInSortedSuballocatedIntVector
protected int findInSortedSuballocatedIntVector(SuballocatedIntVector vector, int lookfor)(Code)
Subroutine: Locate the specified node within m_namespaceDeclSetElements, or the last element which preceeds it in document order %REVIEW% Inlne this into findNamespaceContext? Create SortedSuballocatedIntVector type? If positive or zero, the index of the found item.If negative, index of the point at which it would have appeared,encoded as -1-index and hence reconvertable by subtractingit from -1. (Encoding because I don't want to recompare the stringsbut don't want to burn bytes on a datatype to hold a flagged value.)



findNamespaceContext
protected SuballocatedIntVector findNamespaceContext(int elementNodeIndex)(Code)
Retrieve list of namespace declaration locations active at this node. List is an SuballocatedIntVector whose entries are the namespace node HANDLES declared at that ID. %REVIEW% Directly managed arrays rather than vectors? %REVIEW% Handles or IDs? Given usage, I think handles.



getAttributeNode
abstract public int getAttributeNode(int nodeHandle, String namespaceURI, String name)(Code)
Retrieves an attribute node by by qualified name and namespace URI.
Parameters:
  nodeHandle - int Handle of the node upon which to look up this attribute..
Parameters:
  namespaceURI - The namespace URI of the attribute toretrieve, or null.
Parameters:
  name - The local name of the attribute toretrieve. The attribute node handle with the specified name (nodeName) or DTM.NULL if there is no suchattribute.



getDTMIDs
public SuballocatedIntVector getDTMIDs()(Code)
Query which DTMIDs this DTM is currently using within the DTMManager. %REVEW% Should this become part of the base DTM API? an IntVector, or null if this is a "stand-alone" DTM.



getDocument
public int getDocument()(Code)
Find the Document node handle for the document currently under construction. PLEASE NOTE that most people should use getOwnerDocument(nodeHandle) instead; this version of the operation is primarily intended for use during negotiation with the DTM Manager. int Node handle of document, which should always be valid.



getDocumentAllDeclarationsProcessed
public boolean getDocumentAllDeclarationsProcessed()(Code)
Return an indication of whether the processor has read the complete DTD. Its value is a boolean. If it is false, then certain properties (indicated in their descriptions below) may be unknown. If it is true, those properties are never unknown. true if all declarations were processed;false otherwise.



getDocumentBaseURI
public String getDocumentBaseURI()(Code)
Return the base URI of the document entity. If it is not known (because the document was parsed from a socket connection or from standard input, for example), the value of this property is unknown. the document base URI String object or null if unknown.



getDocumentEncoding
public String getDocumentEncoding(int nodeHandle)(Code)
Return the name of the character encoding scheme in which the document entity is expressed.
Parameters:
  nodeHandle - The node id, which can be any valid node handle. the document encoding String object.



getDocumentRoot
public int getDocumentRoot(int nodeHandle)(Code)
Given a node handle, find the owning document node. Unlike the DOM, this considers the owningDocument of a Document to be itself.
Parameters:
  nodeHandle - the id of the node. int Node handle of owning document, or the nodeHandle if it isa Document.



getDocumentStandalone
public String getDocumentStandalone(int nodeHandle)(Code)
Return an indication of the standalone status of the document, either "yes" or "no". This property is derived from the optional standalone document declaration in the XML declaration at the beginning of the document entity, and has no value if there is no standalone document declaration.
Parameters:
  nodeHandle - The node id, which can be any valid node handle. the document standalone String object, either "yes", "no", or null.



getDocumentSystemIdentifier
public String getDocumentSystemIdentifier(int nodeHandle)(Code)
Return the system identifier of the document entity. If it is not known, the value of this property is unknown.
Parameters:
  nodeHandle - The node id, which can be any valid node handle. the system identifier String object or null if unknown.



getDocumentTypeDeclarationPublicIdentifier
abstract public String getDocumentTypeDeclarationPublicIdentifier()(Code)
Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML]. If there is no external subset or if it has no public identifier, this property has no value. the public identifier String object, or null if there is none.



getDocumentTypeDeclarationSystemIdentifier
abstract public String getDocumentTypeDeclarationSystemIdentifier()(Code)
A document type declaration information item has the following properties: 1. [system identifier] The system identifier of the external subset, if it exists. Otherwise this property has no value. the system identifier String object, or null if there is none.



getDocumentVersion
public String getDocumentVersion(int documentHandle)(Code)
Return a string representing the XML version of the document. This property is derived from the XML declaration optionally present at the beginning of the document entity, and has no value if there is no XML declaration.
Parameters:
  documentHandle - The document handle the document version String object.



getElementById
abstract public int getElementById(String elementId)(Code)
Returns the Element whose ID is given by elementId. If no such element exists, returns DTM.NULL. Behavior is not defined if more than one element has this ID. Attributes (including those with the name "ID") are not of type ID unless so defined by DTD/Schema information available to the DTM implementation. Implementations that do not know whether attributes are of type ID or not are expected to return DTM.NULL.

%REVIEW% Presumably IDs are still scoped to a single document, and this operation searches only within a single document, right? Wouldn't want collisions between DTMs in the same process.


Parameters:
  elementId - The unique id value for an element. The handle of the matching element.



getExpandedTypeID
public int getExpandedTypeID(int nodeHandle)(Code)
Given a node handle, return an ID that represents the node's expanded name.
Parameters:
  nodeHandle - The handle to the node in question. the expanded-name id of the node.



getExpandedTypeID
public int getExpandedTypeID(String namespace, String localName, int type)(Code)
Given an expanded name, return an ID. If the expanded-name does not exist in the internal tables, the entry will be created, and the ID will be returned. Any additional nodes that are created that have this expanded name will use this ID.
Parameters:
  type - The simple type, i.e. one of ELEMENT, ATTRIBUTE, etc.
Parameters:
  namespace - The namespace URI, which may be null, may be an emptystring (which will be the same as null), or may be anamespace URI.
Parameters:
  localName - The local name string, which must be a validNCName. the expanded-name id of the node.



getFirstAttribute
public int getFirstAttribute(int nodeHandle)(Code)
Given a node handle, get the index of the node's first attribute.
Parameters:
  nodeHandle - int Handle of the node. Handle of first attribute, or DTM.NULL to indicate none exists.



getFirstAttributeIdentity
protected int getFirstAttributeIdentity(int identity)(Code)
Given a node identity, get the index of the node's first attribute.
Parameters:
  identity - int identity of the node. Identity of first attribute, or DTM.NULL to indicate none exists.



getFirstChild
public int getFirstChild(int nodeHandle)(Code)
Given a node handle, get the handle of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node. int DTM node-number of first child, or DTM.NULL to indicate none exists.



getFirstNamespaceNode
public int getFirstNamespaceNode(int nodeHandle, boolean inScope)(Code)
Given a node handle, get the index of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again
Parameters:
  nodeHandle - handle to node, which should probably be an elementnode, but need not be.
Parameters:
  inScope - true if all namespaces in scope should be returned,false if only the namespace declarations should bereturned. handle of first namespace, or DTM.NULL to indicate none exists.



getLastChild
public int getLastChild(int nodeHandle)(Code)
Given a node handle, advance to its last child. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node. int Node-number of last child,or DTM.NULL to indicate none exists.



getLevel
public short getLevel(int nodeHandle)(Code)
Get the depth level of this node in the tree (equals 1 for a parentless node).
Parameters:
  nodeHandle - The node id. the number of ancestors, plus one



getLocalName
abstract public String getLocalName(int nodeHandle)(Code)
Given a node handle, return its XPath-style localname. (As defined in Namespaces, this is the portion of the name after any colon character).
Parameters:
  nodeHandle - the id of the node. String Local name of this node.



getLocalNameFromExpandedNameID
public String getLocalNameFromExpandedNameID(int expandedNameID)(Code)
Given an expanded-name ID, return the local name part.
Parameters:
  expandedNameID - an ID that represents an expanded-name. String Local name of this node.



getManager
public DTMManager getManager()(Code)
Query which DTMManager this DTM is currently being handled by. %REVEW% Should this become part of the base DTM API? a DTMManager, or null if this is a "stand-alone" DTM.



getNamespaceFromExpandedNameID
public String getNamespaceFromExpandedNameID(int expandedNameID)(Code)
Given an expanded-name ID, return the namespace URI part.
Parameters:
  expandedNameID - an ID that represents an expanded-name. String URI value of this node's namespace, or null if nonamespace was resolved.



getNamespaceType
public int getNamespaceType(int nodeHandle)(Code)
Returns the namespace type of a specific node
Parameters:
  nodeHandle - the id of the node. the ID of the namespace.



getNamespaceURI
abstract public String getNamespaceURI(int nodeHandle)(Code)
Given a node handle, return its DOM-style namespace URI (As defined in Namespaces, this is the declared URI which this node's prefix -- or default in lieu thereof -- was mapped to.)

%REVIEW% Null or ""? -sb


Parameters:
  nodeHandle - the id of the node. String URI value of this node's namespace, or null if nonamespace was resolved.



getNextAttribute
public int getNextAttribute(int nodeHandle)(Code)
Given a node handle, advance to the next attribute. If an attr, we advance to the next attr on the same node. If not an attribute, we return NULL.
Parameters:
  nodeHandle - int Handle of the node. int DTM node-number of the resolved attr,or DTM.NULL to indicate none exists.



getNextAttributeIdentity
protected int getNextAttributeIdentity(int identity)(Code)
Given a node identity for an attribute, advance to the next attribute.
Parameters:
  identity - int identity of the attribute node. Thismust be an attribute node. int DTM node-identity of the resolved attr,or DTM.NULL to indicate none exists.



getNextNamespaceNode
public int getNextNamespaceNode(int baseHandle, int nodeHandle, boolean inScope)(Code)
Given a namespace handle, advance to the next namespace.
Parameters:
  baseHandle - handle to original node from where the first namespacewas relative to (needed to return nodes in document order).
Parameters:
  nodeHandle - A namespace handle for which we will find the next node.
Parameters:
  inScope - true if all namespaces that are in scope should be processed,otherwise just process the nodes in the given element handle. handle of next namespace, or DTM.NULL to indicate none exists.



getNextNodeIdentity
abstract protected int getNextNodeIdentity(int identity)(Code)
Get the next node identity value in the list, and call the iterator if it hasn't been added yet.
Parameters:
  identity - The node identity (index). identity+1, or DTM.NULL.



getNextSibling
public int getNextSibling(int nodeHandle)(Code)
Given a node handle, advance to its next sibling. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node. int Node-number of next sibling,or DTM.NULL to indicate none exists.



getNode
public org.w3c.dom.Node getNode(int nodeHandle)(Code)
Return an DOM node for the given node.
Parameters:
  nodeHandle - The node ID. A node representation of the DTM node.



getNodeHandle
public int getNodeHandle(int nodeId)(Code)
Get the handle of this node in the tree
Parameters:
  nodeId - The node identity. the node handle



getNodeIdent
public int getNodeIdent(int nodeHandle)(Code)
Get the identity of this node in the tree
Parameters:
  nodeHandle - The node handle. the node identity



getNodeName
abstract public String getNodeName(int nodeHandle)(Code)
Given a node handle, return its DOM-style node name. This will include names such as #text or #document.
Parameters:
  nodeHandle - the id of the node. String Name of this node, which may be an empty string.%REVIEW% Document when empty string is possible...%REVIEW-COMMENT% It should never be empty, should it?



getNodeNameX
public String getNodeNameX(int nodeHandle)(Code)
Given a node handle, return the XPath node name. This should be the name as described by the XPath data model, NOT the DOM-style name.
Parameters:
  nodeHandle - the id of the node. String Name of this node, which may be an empty string.



getNodeType
public short getNodeType(int nodeHandle)(Code)
Given a node handle, return its DOM-style node type.

%REVIEW% Generally, returning short is false economy. Return int? %REVIEW% Make assumption that node has already arrived. Is OK?
Parameters:
  nodeHandle - The node id. int Node type, as per the DOM's Node._NODE constants.




getNodeValue
abstract public String getNodeValue(int nodeHandle)(Code)
Given a node handle, return its node value. This is mostly as defined by the DOM, but may ignore some conveniences.


Parameters:
  nodeHandle - The node id. String Value of this node, or null if notmeaningful for this node type.




getNumberOfNodes
abstract protected int getNumberOfNodes()(Code)
Get the number of nodes that have been added. the number of nodes that have been mapped.



getOwnerDocument
public int getOwnerDocument(int nodeHandle)(Code)
Given a node handle, find the owning document node. This has the exact same semantics as the DOM Document method of the same name, in that if the nodeHandle is a document node, it will return NULL.

%REVIEW% Since this is DOM-specific, it may belong at the DOM binding layer. Included here as a convenience function and to aid porting of DOM code to DTM.


Parameters:
  nodeHandle - the id of the node. int Node handle of owning document, or -1 if the node was a Docment



getParent
public int getParent(int nodeHandle)(Code)
Given a node handle, find its parent node.
Parameters:
  nodeHandle - the id of the node. int Node-number of parent,or DTM.NULL to indicate none exists.



getPrefix
abstract public String getPrefix(int nodeHandle)(Code)
Given a namespace handle, return the prefix that the namespace decl is mapping. Given a node handle, return the prefix used to map to the namespace.

%REVIEW% Are you sure you want "" for no prefix?

%REVIEW-COMMENT% I think so... not totally sure. -sb


Parameters:
  nodeHandle - the id of the node. String prefix of this node's name, or "" if no explicitnamespace prefix was given.



getPreviousSibling
public int getPreviousSibling(int nodeHandle)(Code)
Given a node handle, find its preceeding sibling. WARNING: DTM is asymmetric; this operation is resolved by search, and is relatively expensive.
Parameters:
  nodeHandle - the id of the node. int Node-number of the previous sib,or DTM.NULL to indicate none exists.



getShouldStripWhitespace
protected boolean getShouldStripWhitespace()(Code)
Find out whether or not to strip whispace nodes. whether or not to strip whispace nodes.



getStringValue
abstract public XMLString getStringValue(int nodeHandle)(Code)
Get the string-value of a node as a String object (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
Parameters:
  nodeHandle - The node ID. A string object that represents the string-value of the given node.



getStringValueChunk
public char[] getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)(Code)
Get a character array chunk in the string-value of a node. (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Note that a single text node may have multiple text chunks.
Parameters:
  nodeHandle - The node ID.
Parameters:
  chunkIndex - Which chunk to get.
Parameters:
  startAndLen - An array of 2 where the start position and length ofthe chunk will be returned. The character array reference where the chunk occurs.



getStringValueChunkCount
public int getStringValueChunkCount(int nodeHandle)(Code)
Get number of character array chunks in the string-value of a node. (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Note that a single text node may have multiple text chunks.
Parameters:
  nodeHandle - The node ID. number of character array chunks inthe string-value of a node.



getTypedAttribute
protected int getTypedAttribute(int nodeHandle, int attType)(Code)
Given a node handle and an expanded type ID, get the index of the node's attribute of that type, if any.
Parameters:
  nodeHandle - int Handle of the node.
Parameters:
  attType - int expanded type ID of the required attribute. Handle of attribute of the required type, or DTM.NULL to indicatenone exists.



getTypedFirstChild
public int getTypedFirstChild(int nodeHandle, int nodeType)(Code)
Given a node handle, get the handle of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node. int DTM node-number of first child, or DTM.NULL to indicate none exists.



getTypedNextSibling
public int getTypedNextSibling(int nodeHandle, int nodeType)(Code)
Given a node handle, advance to its next sibling. If not yet resolved, waits for more nodes to be added to the document and tries again.
Parameters:
  nodeHandle - int Handle of the node. int Node-number of next sibling,or DTM.NULL to indicate none exists.



getUnparsedEntityURI
abstract public String getUnparsedEntityURI(String name)(Code)
The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]). It returns the empty string if there is no such entity.

XML processors may choose to use the System Identifier (if one is provided) to resolve the entity, rather than the URI in the Public Identifier. The details are dependent on the processor, and we would have to support some form of plug-in resolver to handle this properly. Currently, we simply return the System Identifier if present, and hope that it a usable URI or that our caller can map it to one. TODO: Resolve Public Identifiers... or consider changing function name.

If we find a relative URI reference, XML expects it to be resolved in terms of the base URI of the document. The DOM doesn't do that for us, and it isn't entirely clear whether that should be done here; currently that's pushed up to a higher level of our application. (Note that DOM Level 1 didn't store the document's base URI.) TODO: Consider resolving Relative URIs.

(The DOM's statement that "An XML processor may choose to completely expand entities before the structure model is passed to the DOM" refers only to parsed entities, not unparsed, and hence doesn't affect this function.)
Parameters:
  name - A string containing the Entity Name of the unparsedentity. String containing the URI of the Unparsed Entity, or anempty string if no such entity exists.




hasChildNodes
public boolean hasChildNodes(int nodeHandle)(Code)
Given a node handle, test if it has child nodes.

%REVIEW% This is obviously useful at the DOM layer, where it would permit testing this without having to create a proxy node. It's less useful in the DTM API, where (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and almost as self-evident. But it's a convenience, and eases porting of DOM code to DTM.


Parameters:
  nodeHandle - int Handle of the node. int true if the given node has child nodes.



indexNode
protected void indexNode(int expandedTypeID, int identity)(Code)
Add a node to the element indexes. The node will not be added unless it's an element.
Parameters:
  expandedTypeID - The expanded type ID of the node.
Parameters:
  identity - The node identity index.



isAttributeSpecified
abstract public boolean isAttributeSpecified(int attributeHandle)(Code)
5. [specified] A flag indicating whether this attribute was actually specified in the start-tag of its element, or was defaulted from the DTD.
Parameters:
  attributeHandle - The attribute handle in question. true if the attribute was specified;false if it was defaulted.



isCharacterElementContentWhitespace
public boolean isCharacterElementContentWhitespace(int nodeHandle)(Code)
2. [element content whitespace] A boolean indicating whether the character is white space appearing within element content (see [XML], 2.10 "White Space Handling"). Note that validating XML processors are required by XML 1.0 to provide this information. If there is no declaration for the containing element, this property has no value for white space characters. If no declaration has been read, but the [all declarations processed] property of the document information item is false (so there may be an unread declaration), then the value of this property is unknown for white space characters. It is always false for characters that are not white space.
Parameters:
  nodeHandle - the node ID. true if the character data is whitespace;false otherwise.



isDocumentAllDeclarationsProcessed
public boolean isDocumentAllDeclarationsProcessed(int documentHandle)(Code)
10. [all declarations processed] This property is not strictly speaking part of the infoset of the document. Rather it is an indication of whether the processor has read the complete DTD. Its value is a boolean. If it is false, then certain properties (indicated in their descriptions below) may be unknown. If it is true, those properties are never unknown.
Parameters:
  documentHandle - A node handle that must identify a document. true if all declarations were processed;false otherwise.



isNodeAfter
public boolean isNodeAfter(int nodeHandle1, int nodeHandle2)(Code)
Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model. This may not agree with the ordering defined by other XML applications.

There are some cases where ordering isn't defined, and neither are the results of this function -- though we'll generally return false.
Parameters:
  nodeHandle1 - Node handle to perform position comparison on.
Parameters:
  nodeHandle2 - Second Node handle to perform position comparison on . true if node1 comes before node2, otherwise return false.You can think of this as(node1.documentOrderPosition <= node2.documentOrderPosition).




isSupported
public boolean isSupported(String feature, String version)(Code)
Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node.
Parameters:
  feature - The name of the feature to test.
Parameters:
  version - This is the version number of the feature to test.If the version is notspecified, supporting any version of the feature will cause themethod to return true. Returns true if the specified feature issupported on this node, false otherwise.



makeNodeHandle
final public int makeNodeHandle(int nodeIdentity)(Code)
Given a node identity, return a node handle. If extended addressing has been used (multiple DTM IDs), we need to map the high bits of the identity into the proper DTM ID. This has been made FINAL to facilitate inlining, since we do not expect any subclass of DTMDefaultBase to ever change the algorithm. (I don't really like doing so, and would love to have an excuse not to...) %REVIEW% Is it worth trying to specialcase small documents? %REVIEW% Should this be exposed at the package/public layers?
Parameters:
  nodeIdentity - Internal offset to this node's records. NodeHandle (external representation of node)



makeNodeIdentity
final public int makeNodeIdentity(int nodeHandle)(Code)
Given a node handle, return a node identity. If extended addressing has been used (multiple DTM IDs), we need to map the high bits of the identity into the proper DTM ID and thence find the proper offset to add to the low bits of the identity This has been made FINAL to facilitate inlining, since we do not expect any subclass of DTMDefaultBase to ever change the algorithm. (I don't really like doing so, and would love to have an excuse not to...) %OPT% Performance is critical for this operation. %REVIEW% Should this be exposed at the package/public layers?
Parameters:
  nodeHandle - (external representation of node) nodeIdentity Internal offset to this node's records.



migrateTo
public void migrateTo(DTMManager mgr)(Code)
Migrate a DTM built with an old DTMManager to a new DTMManager. After the migration, the new DTMManager will treat the DTM as one that is built by itself. This is used to support DTM sharing between multiple transformations.
Parameters:
  mgr - the DTMManager



nextNode
abstract protected boolean nextNode()(Code)
This method should try and build one or more nodes in the table. The true if a next node is found or false ifthere are no more nodes.



popShouldStripWhitespace
protected void popShouldStripWhitespace()(Code)
Set whether to strip whitespaces at this point by popping out m_shouldStripWhitespaceStack.



pushShouldStripWhitespace
protected void pushShouldStripWhitespace(boolean shouldStrip)(Code)
Set whether to strip whitespaces and push in current value of m_shouldStripWS in m_shouldStripWhitespaceStack.
Parameters:
  shouldStrip - Flag indicating whether to strip whitespace nodes



setDocumentBaseURI
public void setDocumentBaseURI(String baseURI)(Code)
Set the base URI of the document entity.
Parameters:
  baseURI - the document base URI String object or null if unknown.



setFeature
public void setFeature(String featureId, boolean state)(Code)
Set an implementation dependent feature.

%REVIEW% Do we really expect to set features on DTMs?
Parameters:
  featureId - A feature URL.
Parameters:
  state - true if this feature should be on, false otherwise.




setShouldStripWhitespace
protected void setShouldStripWhitespace(boolean shouldStrip)(Code)
Set whether to strip whitespaces and set the top of the stack to the current value of m_shouldStripWS.
Parameters:
  shouldStrip - Flag indicating whether to strip whitespace nodes



supportsPreStripping
public boolean supportsPreStripping()(Code)
Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the DTM document. true if this DTM supports prestripping.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.