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


net.sf.saxon.om.SequenceIterator

All known Subclasses:   net.sf.saxon.expr.MappingIterator,  net.sf.saxon.expr.UnionEnumeration,  net.sf.saxon.expr.StringTokenIterator,  net.sf.saxon.om.ClosingIterator,  net.sf.saxon.expr.DifferenceEnumeration,  net.sf.saxon.sort.DocumentOrderIterator,  net.sf.saxon.instruct.RegexIterator,  net.sf.saxon.expr.PositionIterator,  net.sf.saxon.expr.IntersectionEnumeration,  net.sf.saxon.expr.AppendIterator,  net.sf.saxon.sort.SortedIterator,  net.sf.saxon.expr.FilterIterator,
SequenceIterator
public interface SequenceIterator (Code)
A SequenceIterator is used to iterate over any XPath 2 sequence (of values or nodes). To get the next item in a sequence, call next(); if this returns null, you've reached the end of the sequence.

A SequenceIterator keeps track of the current Item and the current position. The objects returned by the SequenceIterator will always be either nodes (class NodeInfo) or singleton values (class AtomicValue): these are represented collectively by the interface Item.

This interface forms part of the public Saxon API. The JavaDoc "since" flag is used from release 8.4 onwards to indicate methods that are considered to be a stable part of the API. Methods without a "since" flag should not be regarded as a stable part of the API.

Note that the stability of this interface applies to classes that use the interface, not to classes that implement it. The interface may be extended in future to add new methods.
author:
   Michael H. Kay
since:
   8.4



Field Summary
final public static  intATOMIZABLE
    
final public static  intGROUNDED
     Property value: the iterator is "grounded".
final public static  intLAST_POSITION_FINDER
     Property value: the iterator knows the number of items that it will deliver.
final public static  intLOOKAHEAD
     Property value: the iterator knows whether there are more items still to come.


Method Summary
public  Itemcurrent()
     Get the current value in the sequence (the one returned by the most recent call on next()).
public  SequenceIteratorgetAnother()
     Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.

This method allows access to all the items in the sequence without disturbing the current position of the iterator.

public  intgetProperties()
     Get properties of this iterator, as a bit-significant integer. the properties of this iterator.
public  Itemnext()
     Get the next item in the sequence.
public  intposition()
     Get the current position.

Field Detail
ATOMIZABLE
final public static int ATOMIZABLE(Code)
Property value: the iterator supports a setAtomizing() method, which requests (but does not require) the iterator to atomize any nodes and return their typed values



GROUNDED
final public static int GROUNDED(Code)
Property value: the iterator is "grounded". This means that (a) the iterator must be an instance of GroundedIterator , and (b) the implementation of the materialize() method must be efficient (in particular, it should not involve the creation of new objects)



LAST_POSITION_FINDER
final public static int LAST_POSITION_FINDER(Code)
Property value: the iterator knows the number of items that it will deliver. This means that (a) the iterator must be an instance of net.sf.saxon.expr.LastPositionFinder , and (b) the implementation of the getLastPosition() method must be efficient (in particular, it should take constant time, rather than time proportional to the length of the sequence)



LOOKAHEAD
final public static int LOOKAHEAD(Code)
Property value: the iterator knows whether there are more items still to come. This means that (a) the iterator must be an instance of LookaheadIterator , and (b) the implementation of the hasNext() method must be efficient (more efficient than the client doing it)





Method Detail
current
public Item current()(Code)
Get the current value in the sequence (the one returned by the most recent call on next()). This will be null before the first call of next(). This method does not change the state of the iterator. the current item, the one most recently returned by a call onnext(). Returns null if next() has not been called, or if the endof the sequence has been reached.
since:
   8.4



getAnother
public SequenceIterator getAnother() throws XPathException(Code)
Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.

This method allows access to all the items in the sequence without disturbing the current position of the iterator. Internally, its main use is in evaluating the last() function.

This method does not change the state of the iterator.
exception:
  XPathException - if any error occurs a SequenceIterator that iterates over the same items,positioned before the first item
since:
   8.4




getProperties
public int getProperties()(Code)
Get properties of this iterator, as a bit-significant integer. the properties of this iterator. This will be some combination ofproperties such as GROUNDED, LAST_POSITION_FINDER,and LOOKAHEAD. It is alwaysacceptable to return the value zero, indicating that there are no known special properties.It is acceptable for the properties of the iterator to change depending on its state.
since:
   8.6



next
public Item next() throws XPathException(Code)
Get the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().
throws:
  XPathException - if an error occurs retrieving the next item the next item, or null if there are no more items. Once a callon next() has returned null, no further calls should be made. The preferredaction for an iterator if subsequent calls on next() are made is to returnnull again, and all implementations within Saxon follow this rule.
since:
   8.4



position
public int position()(Code)
Get the current position. This will usually be zero before the first call on next(), otherwise it will be the number of times that next() has been called. Once next() has returned null, the preferred action is for subsequent calls on position() to return -1, but not all existing implementations follow this practice. (In particular, the EmptyIterator is stateless, and always returns 0 as the value of position(), whether or not next() has been called.)

This method does not change the state of the iterator. the current position, the position of the item returned by themost recent call of next(). This is 1 after next() has been successfullycalled once, 2 after it has been called twice, and so on. If next() hasnever been called, the method returns zero. If the end of the sequencehas been reached, the value returned will always be <= 0; the preferredvalue is -1.
since:
   8.4




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