KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > hp > hpl > jena > rdf > model > NodeIterator


1 /*
2  * (c) Copyright 2000, 2001, 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * NodeIterator.java
28  *
29  * Created on 28 July 2000, 13:36
30  */
31
32 package com.hp.hpl.jena.rdf.model;
33
34 import com.hp.hpl.jena.util.iterator.ClosableIterator;
35 import java.util.NoSuchElementException JavaDoc;
36
37 /** An iterator which returns RDF nodes.
38  *
39  * <p>RDF iterators are standard Java iterators, except that they
40  * have an extra method that returns specifically typed objects,
41  * in this case RDF nodes, and have a <CODE>close()</CODE> method.
42  * thatshould be called to free resources if the application does
43  * not complete the iteration.</p>
44  * @author bwm
45  * @version Release='$Name: $' Revision='$Revision: 1.7 $' Date='$Date: 2005/02/21 12:14:20 $'
46  */
47 public interface NodeIterator extends ClosableIterator {
48     /** Determine if there any more values in the iteration.
49      .
50      * @return true if and only if there are more values available
51      * from the iteration.
52      */
53     public boolean hasNext() ;
54     /** Return the next RDFNode of the iteration.
55      * @throws NoSuchElementException if there are no more nodes to be returned.
56      .
57      * @return The next RDFNode from the iteration.
58      */
59     public Object JavaDoc next() throws NoSuchElementException JavaDoc;
60     /** Return the next RDFNode of the iteration.
61      * @throws NoSuchElementException if there are no more nodes to be returned.
62      .
63      * @return The next RDFNode from the iteration.
64      */
65     public RDFNode nextNode() throws NoSuchElementException JavaDoc;
66     /** Unsupported Operation.
67      * @throws NoSuchElementException
68      */
69     public void remove() throws NoSuchElementException JavaDoc;
70     /** Terminate the iteration and free up resources.
71      *
72      * <p>Some implementations, e.g. on relational databases, hold resources while
73      * the iterator still exists. These will normally be freed when the iteration
74      * completes. However, if an application wishes to ensure they are freed without
75      * completing the iteration, this method should be called.</p>
76      .
77      */
78     public void close() ;
79 }
80
Popular Tags