← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to solr/core/src/java/org/apache/solr/search/DocIterator.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

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