1 package org.apache.lucene.facet.search;
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 * Iterator over document IDs and their scores. Each {@link #next()} retrieves
22 * the next docID and its score which can be later be retrieved by
23 * {@link #getDocID()} and {@link #getScore()}. <b>NOTE:</b> you must call
24 * {@link #next()} before {@link #getDocID()} and/or {@link #getScore()}, or
25 * otherwise the returned values are unexpected.
27 * @lucene.experimental
29 public interface ScoredDocIDsIterator {
31 /** Default score used in case scoring is disabled. */
32 public static final float DEFAULT_SCORE = 1.0f;
34 /** Iterate to the next document/score pair. Returns true iff there is such a pair. */
35 public abstract boolean next();
37 /** Returns the ID of the current document. */
38 public abstract int getDocID();
40 /** Returns the score of the current document. */
41 public abstract float getScore();