Java Doc for VirtualTreeWalker.java in  » XML » saxonb » net » sf » saxon » pull » 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 » saxonb » net.sf.saxon.pull 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sf.saxon.pull.VirtualTreeWalker

VirtualTreeWalker
public class VirtualTreeWalker implements PullProvider,NamespaceDeclarations(Code)
A virtual tree walker provides a sequence of pull events describing the structure and content of a tree that is conceptually being constructed by expressions in a query or stylesheet; in fact the tree is not necessarily constructed in memory, and exists only as this stream of pull events.

The tree is physically constructed if operations are requested that depend on the identity of the nodes in the tree, or that navigate within the tree. Operations such as copying or atomizing the tree can be done directly, without building it in memory. (Note however that if such operations are done more than once, the underlying instructions may be evaluated repeatedly.)




Constructor Summary
public  VirtualTreeWalker(ParentNodeConstructor instruction, XPathContext context)
    

Method Summary
public  voidclose()
     Close the event reader.
public  intcurrent()
     Get the event most recently returned by next(), or by other calls that change the position, for example getStringValue() and skipToMatchingEnd().
public  AtomicValuegetAtomicValue()
     Get an atomic value.
public  AttributeCollectiongetAttributes()
     Get the attributes associated with the current element.
public  intgetFingerprint()
     Get the fingerprint of the name of the element.
public  intgetLength()
     Get the number of declarations (and undeclarations) in this list.
public  intgetNameCode()
     Get the nameCode identifying the name of the current node.
public  NamePoolgetNamePool()
    
public  intgetNamespaceCode(int index)
     Get the n'th declaration in the list in the form of a namespace code.
public  int[]getNamespaceCodes(int[] buffer)
     Get all the namespace codes, as an array.
Parameters:
  buffer - a sacrificial array that the method is free to use to contain the result.May be null.
public  NamespaceDeclarationsgetNamespaceDeclarations()
     Get the namespace declarations associated with the current element.
public  PipelineConfigurationgetPipelineConfiguration()
     Get configuration information.
public  StringgetPrefix(int index)
     Get the prefix of the n'th declaration (or undeclaration) in the list, counting from zero.
Parameters:
  index - the index identifying which declaration is required.
public  SourceLocatorgetSourceLocator()
     Get the location of the current event. For an event stream representing a real document, the location information should identify the location in the lexical XML source.
public  CharSequencegetStringValue()
     Get the string value of the current element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value.

In other situations the result is undefined and may result in an IllegalStateException.

If the most recent event was a VirtualTreeWalker.START_ELEMENT , this method causes the content of the element to be read.

public  intgetTypeAnnotation()
     Get the type annotation of the current attribute or element node, or atomic value. The result of this method is undefined unless the most recent event was START_ELEMENT, ATTRIBUTE, or ATOMIC_VALUE. the type annotation.
public  StringgetURI(int index)
     Get the namespace URI of the n'th declaration (or undeclaration) in the list, counting from zero.
Parameters:
  index - the index identifying which declaration is required.
public  intnext()
     Get the next event an integer code indicating the type of event.
public  voidsetNameCode(int nameCode)
    
public  voidsetPipelineConfiguration(PipelineConfiguration pipe)
     Set configuration information.
public  intskipToMatchingEnd()
     Skip the current subtree.


Constructor Detail
VirtualTreeWalker
public VirtualTreeWalker(ParentNodeConstructor instruction, XPathContext context)(Code)
Create a VirtualTreeWalker to navigate the tree constructed by evaluating a given instruction in a given dyamic context
Parameters:
  instruction - the instruction (this will always be an instruction that creates element ordocument nodes)
Parameters:
  context - the dynamic evaluation context




Method Detail
close
public void close()(Code)
Close the event reader. This indicates that no further events are required. It is not necessary to close an event reader after VirtualTreeWalker.END_OF_INPUT has been reported, but it is recommended to close it if reading terminates prematurely. Once an event reader has been closed, the effect of further calls on next() is undefined.



current
public int current()(Code)
Get the event most recently returned by next(), or by other calls that change the position, for example getStringValue() and skipToMatchingEnd(). This method does not change the position of the PullProvider. the current event



getAtomicValue
public AtomicValue getAtomicValue()(Code)
Get an atomic value. This call may be used only when the last event reported was ATOMIC_VALUE. This indicates that the PullProvider is reading a sequence that contains a free-standing atomic value; it is never used when reading the content of a node.



getAttributes
public AttributeCollection getAttributes() throws XPathException(Code)
Get the attributes associated with the current element. This method must be called only after a START_ELEMENT event has been notified. The contents of the returned AttributeCollection are guaranteed to remain unchanged until the next START_ELEMENT event, but may be modified thereafter. The object should not be modified by the client.

Attributes may be read before or after reading the namespaces of an element, but must not be read after the first child node has been read, or after calling one of the methods skipToEnd(), getStringValue(), or getTypedValue().

an AttributeCollection representing the attributes of the elementthat has just been notified.



getFingerprint
public int getFingerprint()(Code)
Get the fingerprint of the name of the element. This is similar to the nameCode, except that it does not contain any information about the prefix: so two elements with the same fingerprint have the same name, excluding prefix. This method can be used after the VirtualTreeWalker.START_ELEMENT , VirtualTreeWalker.END_ELEMENT , VirtualTreeWalker.PROCESSING_INSTRUCTION , VirtualTreeWalker.ATTRIBUTE , or VirtualTreeWalker.NAMESPACE events. If called at other times, the result is undefined and may result in an IllegalStateException. If called when the current node is an unnamed namespace node (a node representing the default namespace) the returned value is -1. the fingerprint. The fingerprint can be used to obtain the local nameand namespace URI from the name pool.



getLength
public int getLength()(Code)
Get the number of declarations (and undeclarations) in this list.



getNameCode
public int getNameCode()(Code)
Get the nameCode identifying the name of the current node. This method can be used after the VirtualTreeWalker.START_ELEMENT , VirtualTreeWalker.END_ELEMENT , VirtualTreeWalker.PROCESSING_INSTRUCTION , VirtualTreeWalker.ATTRIBUTE , or VirtualTreeWalker.NAMESPACE events. With some PullProvider implementations, but not this one, it can also be used after VirtualTreeWalker.END_ELEMENT . If called at other times, the result is undefined and may result in an IllegalStateException. If called when the current node is an unnamed namespace node (a node representing the default namespace) the returned value is -1. the nameCode. The nameCode can be used to obtain the prefix, local name,and namespace URI from the name pool.



getNamePool
public NamePool getNamePool()(Code)
Get the namepool



getNamespaceCode
public int getNamespaceCode(int index)(Code)
Get the n'th declaration in the list in the form of a namespace code. Namespace codes can be translated into a prefix and URI by means of methods in the NamePool
Parameters:
  index - the index identifying which declaration is required. the namespace code. This is an integer whose upper half indicatesthe prefix (0 represents the default namespace), and whose lower half indicatesthe URI (0 represents an undeclaration).
throws:
  IndexOutOfBoundsException - if the index is out of range.
See Also:   net.sf.saxon.om.NamePool.getPrefixFromNamespaceCode(int)
See Also:   net.sf.saxon.om.NamePool.getURIFromNamespaceCode(int)



getNamespaceCodes
public int[] getNamespaceCodes(int[] buffer)(Code)
Get all the namespace codes, as an array.
Parameters:
  buffer - a sacrificial array that the method is free to use to contain the result.May be null. an integer array containing namespace codes. The array may be filled completelywith namespace codes, or it may be incompletely filled, in which case a -1 integer actsas a terminator.



getNamespaceDeclarations
public NamespaceDeclarations getNamespaceDeclarations() throws XPathException(Code)
Get the namespace declarations associated with the current element. This method must be called only after a START_ELEMENT event has been notified. In the case of a top-level START_ELEMENT event (that is, an element that either has no parent node, or whose parent is not included in the sequence being read), the NamespaceDeclarations object returned will contain a namespace declaration for each namespace that is in-scope for this element node. In the case of a non-top-level element, the NamespaceDeclarations will contain a set of namespace declarations and undeclarations, representing the differences between this element and its parent.

It is permissible for this method to return namespace declarations that are redundant.

The NamespaceDeclarations object is guaranteed to remain unchanged until the next START_ELEMENT event, but may then be overwritten. The object should not be modified by the client.

Namespaces may be read before or after reading the attributes of an element, but must not be read after the first child node has been read, or after calling one of the methods skipToEnd(), getStringValue(), or getTypedValue().

*



getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()(Code)
Get configuration information.



getPrefix
public String getPrefix(int index)(Code)
Get the prefix of the n'th declaration (or undeclaration) in the list, counting from zero.
Parameters:
  index - the index identifying which declaration is required. the namespace prefix. For a declaration or undeclaration of thedefault namespace, this is the zero-length string.
throws:
  IndexOutOfBoundsException - if the index is out of range.



getSourceLocator
public SourceLocator getSourceLocator()(Code)
Get the location of the current event. For an event stream representing a real document, the location information should identify the location in the lexical XML source. For a constructed document, it should identify the location in the query or stylesheet that caused the node to be created. A value of null can be returned if no location information is available.



getStringValue
public CharSequence getStringValue() throws XPathException(Code)
Get the string value of the current element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value.

In other situations the result is undefined and may result in an IllegalStateException.

If the most recent event was a VirtualTreeWalker.START_ELEMENT , this method causes the content of the element to be read. The current event on completion of this method will be the corresponding VirtualTreeWalker.END_ELEMENT . The next call of next() will return the event following the END_ELEMENT event.

the String Value of the node in question, defined according to the rules in theXPath data model.



getTypeAnnotation
public int getTypeAnnotation()(Code)
Get the type annotation of the current attribute or element node, or atomic value. The result of this method is undefined unless the most recent event was START_ELEMENT, ATTRIBUTE, or ATOMIC_VALUE. the type annotation. This code is the fingerprint of a type name, which may beresolved to a net.sf.saxon.type.SchemaType by access to the Configuration.



getURI
public String getURI(int index)(Code)
Get the namespace URI of the n'th declaration (or undeclaration) in the list, counting from zero.
Parameters:
  index - the index identifying which declaration is required. the namespace URI. For a namespace undeclaration, this is thezero-length string.
throws:
  IndexOutOfBoundsException - if the index is out of range.



next
public int next() throws XPathException(Code)
Get the next event an integer code indicating the type of event. The codeVirtualTreeWalker.END_OF_INPUT is returned at the end of the sequence.



setNameCode
public void setNameCode(int nameCode)(Code)
Set the initial nameCode (the nameCode of the node at the root of the tree being walked)



setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)(Code)
Set configuration information. This must only be called before any events have been read.



skipToMatchingEnd
public int skipToMatchingEnd() throws XPathException(Code)
Skip the current subtree. This method may be called only immediately after a START_DOCUMENT or START_ELEMENT event. This call returns the matching END_DOCUMENT or END_ELEMENT event; the next call on next() will return the event following the END_DOCUMENT or END_ELEMENT.
throws:
  IllegalStateException - if the method is called at any time other thanimmediately after a START_DOCUMENT or START_ELEMENT event.



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.