org.apache.lucene.search.grouping.GroupDocs.java Source code

Introduction

Here is the source code for org.apache.lucene.search.grouping.GroupDocs.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.search.grouping;

import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.TotalHits;

/** Represents one group in the results.
 * 
 * @lucene.experimental */
public class GroupDocs<T> {
    /** The groupField value for all docs in this group; this
     *  may be null if hits did not have the groupField. */
    public final T groupValue;

    /** Max score in this group */
    public final float maxScore;

    /** Overall aggregated score of this group (currently only
     *  set by join queries). */
    public final float score;

    /** Hits; this may be {@link
     * org.apache.lucene.search.FieldDoc} instances if the
     * withinGroupSort sorted by fields. */
    public final ScoreDoc[] scoreDocs;

    /** Total hits within this group */
    public final TotalHits totalHits;

    /** Matches the groupSort passed to {@link
     *  FirstPassGroupingCollector}. */
    public final Object[] groupSortValues;

    public GroupDocs(float score, float maxScore, TotalHits totalHits, ScoreDoc[] scoreDocs, T groupValue,
            Object[] groupSortValues) {
        this.score = score;
        this.maxScore = maxScore;
        this.totalHits = totalHits;
        this.scoreDocs = scoreDocs;
        this.groupValue = groupValue;
        this.groupSortValues = groupSortValues;
    }
}