001    package  org.odbms;
002    
003    /* Copyright 2002-2005 The Apache Software Foundation
004     *
005     * Licensed under the Apache License, Version 2.0 (the "License");
006     * you may not use this file except in compliance with the License.
007     * You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    /**
019     * query resultset.
020     * <br><br>The <code>ObjectSet</code> interface providedes iterator functions to
021     * navigate through a set of objects retrieved by a query.
022     */
023    public interface ObjectSet {
024    
025    
026        /**
027             * returns <code>true</code> if the <code>ObjectSet</code> has more elements.
028         * @return boolean <code>true</code> if the <code>ObjectSet</code> has more
029             * elements.
030         */
031        public boolean hasNext ();
032    
033    
034        /**
035             * returns the next object in the <code>ObjectSet</code>.
036         * @return the next object in the <code>ObjectSet</code>.
037         */
038        public Object next ();
039    
040    
041        /**
042             * resets the <code>ObjectSet</code> cursor before the first element. <br><br>
043             * A subsequent call to <code>next()</code> will return the first element.
044         */
045        public void reset ();
046    
047    
048    
049        /**
050             * returns the number of elements in the <code>ObjectSet</code>.
051         * @return the number of elements in the <code>ObjectSet</code>.
052         */
053        public int size ();
054    }
055    
056    
057