lucene/monitor/src/java/org/apache/lucene/monitor/ScoringMatch.java

/*
 * 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.monitor;

import java.io.IOException;

import org.apache.lucene.search.Scorable;
import org.apache.lucene.search.ScoreMode;
import org.apache.lucene.search.similarities.BM25Similarity;
import org.apache.lucene.search.similarities.Similarity;

/**
 * A QueryMatch that reports scores for each match
 */
public class ScoringMatch extends QueryMatch {

  public static final MatcherFactory<ScoringMatch> matchWithSimilarity(Similarity similarity) {
    return searcher -> {
      searcher.setSimilarity(similarity);
      return new CollectingMatcher<ScoringMatch>(searcher, ScoreMode.COMPLETE) {
        @Override
        protected ScoringMatch doMatch(String queryId, int doc, Scorable scorer) throws IOException {
          float score = scorer.score();
          if (score > 0)
            return new ScoringMatch(queryId, score);
          return null;
        }

        @Override
        public ScoringMatch resolve(ScoringMatch match1, ScoringMatch match2) {
          return new ScoringMatch(match1.getQueryId(), match1.getScore() + match2.getScore());
        }
      };
    };
  }

  public static final MatcherFactory<ScoringMatch> DEFAULT_MATCHER = matchWithSimilarity(new BM25Similarity());

  private final float score;

  private ScoringMatch(String queryId, float score) {
    super(queryId);
    this.score = score;
  }

  public float getScore() {
    return score;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (!(o instanceof ScoringMatch)) return false;
    if (!super.equals(o)) return false;
    ScoringMatch that = (ScoringMatch) o;
    return Float.compare(that.score, score) == 0;

  }

  @Override
  public int hashCode() {
    int result = super.hashCode();
    result = 31 * result + (score != +0.0f ? Float.floatToIntBits(score) : 0);
    return result;
  }
}