1 package org.odbms;
2
3 /* Copyright 2002-2005 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /**
19 * query resultset.
20 * <br><br>The <code>ObjectSet</code> interface providedes iterator functions to
21 * navigate through a set of objects retrieved by a query.
22 */
23 public interface ObjectSet {
24
25
26 /**
27 * returns <code>true</code> if the <code>ObjectSet</code> has more elements.
28 * @return boolean <code>true</code> if the <code>ObjectSet</code> has more
29 * elements.
30 */
31 public boolean hasNext ();
32
33
34 /**
35 * returns the next object in the <code>ObjectSet</code>.
36 * @return the next object in the <code>ObjectSet</code>.
37 */
38 public Object next ();
39
40
41 /**
42 * resets the <code>ObjectSet</code> cursor before the first element. <br><br>
43 * A subsequent call to <code>next()</code> will return the first element.
44 */
45 public void reset ();
46
47
48
49 /**
50 * returns the number of elements in the <code>ObjectSet</code>.
51 * @return the number of elements in the <code>ObjectSet</code>.
52 */
53 public int size ();
54 }
55
56
57