01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: */package org.apache.solr.search;
17:
18: import java.util.Iterator;
19:
20: /**
21: * Simple Iterator of document Ids which may include score information.
22: *
23: * <p>
24: * The order of the documents is determined by the context in which the
25: * DocIterator instance was retrieved.
26: * </p>
27: *
28: * @author yonik
29: * @version $Id: DocIterator.java 472574 2006-11-08 18:25:52Z yonik $
30: */
31: public interface DocIterator extends Iterator<Integer> {
32: // already declared in superclass, redeclaring prevents javadoc inheritance
33: //public boolean hasNext();
34:
35: /**
36: * Returns the next document id if hasNext()==true
37: *
38: * <code>
39: * This method is equivalent to <code>next()</code>, but avoids the creation
40: * of an Integer Object.
41: * @see #next()
42: */
43: public int nextDoc();
44:
45: /**
46: * Returns the score for the document just returned by <code>nextDoc()</code>
47: *
48: * <p>
49: * The value returned may be meaningless depending on the context
50: * in which the DocIterator instance was retrieved.
51: */
52: public float score();
53: }
|