1
package org.apache.lucene.facet.search;
3
import java.io.IOException;
5
import org.apache.lucene.search.DocIdSet;
8
* Licensed to the Apache Software Foundation (ASF) under one or more
9
* contributor license agreements. See the NOTICE file distributed with
10
* this work for additional information regarding copyright ownership.
11
* The ASF licenses this file to You under the Apache License, Version 2.0
12
* (the "License"); you may not use this file except in compliance with
13
* the License. You may obtain a copy of the License at
15
* http://www.apache.org/licenses/LICENSE-2.0
17
* Unless required by applicable law or agreed to in writing, software
18
* distributed under the License is distributed on an "AS IS" BASIS,
19
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
* See the License for the specific language governing permissions and
21
* limitations under the License.
25
* Document IDs with scores for each, driving facets accumulation. Document
26
* scores are optionally used in the process of facets scoring.
28
* @see FacetsAccumulator#accumulate(ScoredDocIDs)
29
* @lucene.experimental
31
public interface ScoredDocIDs {
33
/** Returns an iterator over the document IDs and their scores. */
34
public ScoredDocIDsIterator iterator() throws IOException;
36
/** Returns the set of doc IDs. */
37
public DocIdSet getDocIDs();
39
/** Returns the number of scored documents. */