lucene/sandbox/src/java/org/apache/lucene/sandbox/search/QueryProfilerScorer.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.sandbox.search;

import java.io.IOException;
import java.util.Collection;
import org.apache.lucene.search.DocIdSetIterator;
import org.apache.lucene.search.Scorer;
import org.apache.lucene.search.TwoPhaseIterator;
import org.apache.lucene.search.Weight;

/**
 * {@link Scorer} wrapper that will compute how much time is spent on moving the iterator,
 * confirming matches and computing scores.
 */
class QueryProfilerScorer extends Scorer {

  private final Scorer scorer;
  private QueryProfilerWeight profileWeight;

  private final QueryProfilerTimer scoreTimer,
      nextDocTimer,
      advanceTimer,
      matchTimer,
      shallowAdvanceTimer,
      computeMaxScoreTimer,
      setMinCompetitiveScoreTimer;

  QueryProfilerScorer(QueryProfilerWeight w, Scorer scorer, QueryProfilerBreakdown profile) {
    super(w);
    this.scorer = scorer;
    this.profileWeight = w;
    scoreTimer = profile.getTimer(QueryProfilerTimingType.SCORE);
    nextDocTimer = profile.getTimer(QueryProfilerTimingType.NEXT_DOC);
    advanceTimer = profile.getTimer(QueryProfilerTimingType.ADVANCE);
    matchTimer = profile.getTimer(QueryProfilerTimingType.MATCH);
    shallowAdvanceTimer = profile.getTimer(QueryProfilerTimingType.SHALLOW_ADVANCE);
    computeMaxScoreTimer = profile.getTimer(QueryProfilerTimingType.COMPUTE_MAX_SCORE);
    setMinCompetitiveScoreTimer =
        profile.getTimer(QueryProfilerTimingType.SET_MIN_COMPETITIVE_SCORE);
  }

  @Override
  public int docID() {
    return scorer.docID();
  }

  @Override
  public float score() throws IOException {
    scoreTimer.start();
    try {
      return scorer.score();
    } finally {
      scoreTimer.stop();
    }
  }

  @Override
  public Weight getWeight() {
    return profileWeight;
  }

  @Override
  public Collection<ChildScorable> getChildren() throws IOException {
    return scorer.getChildren();
  }

  @Override
  public DocIdSetIterator iterator() {
    final DocIdSetIterator in = scorer.iterator();
    return new DocIdSetIterator() {

      @Override
      public int advance(int target) throws IOException {
        advanceTimer.start();
        try {
          return in.advance(target);
        } finally {
          advanceTimer.stop();
        }
      }

      @Override
      public int nextDoc() throws IOException {
        nextDocTimer.start();
        try {
          return in.nextDoc();
        } finally {
          nextDocTimer.stop();
        }
      }

      @Override
      public int docID() {
        return in.docID();
      }

      @Override
      public long cost() {
        return in.cost();
      }
    };
  }

  @Override
  public TwoPhaseIterator twoPhaseIterator() {
    final TwoPhaseIterator in = scorer.twoPhaseIterator();
    if (in == null) {
      return null;
    }
    final DocIdSetIterator inApproximation = in.approximation();
    final DocIdSetIterator approximation =
        new DocIdSetIterator() {

          @Override
          public int advance(int target) throws IOException {
            advanceTimer.start();
            try {
              return inApproximation.advance(target);
            } finally {
              advanceTimer.stop();
            }
          }

          @Override
          public int nextDoc() throws IOException {
            nextDocTimer.start();
            try {
              return inApproximation.nextDoc();
            } finally {
              nextDocTimer.stop();
            }
          }

          @Override
          public int docID() {
            return inApproximation.docID();
          }

          @Override
          public long cost() {
            return inApproximation.cost();
          }
        };
    return new TwoPhaseIterator(approximation) {
      @Override
      public boolean matches() throws IOException {
        matchTimer.start();
        try {
          return in.matches();
        } finally {
          matchTimer.stop();
        }
      }

      @Override
      public float matchCost() {
        return in.matchCost();
      }
    };
  }

  @Override
  public int advanceShallow(int target) throws IOException {
    shallowAdvanceTimer.start();
    try {
      return scorer.advanceShallow(target);
    } finally {
      shallowAdvanceTimer.stop();
    }
  }

  @Override
  public float getMaxScore(int upTo) throws IOException {
    computeMaxScoreTimer.start();
    try {
      return scorer.getMaxScore(upTo);
    } finally {
      computeMaxScoreTimer.stop();
    }
  }

  @Override
  public void setMinCompetitiveScore(float minScore) throws IOException {
    setMinCompetitiveScoreTimer.start();
    try {
      scorer.setMinCompetitiveScore(minScore);
    } finally {
      setMinCompetitiveScoreTimer.stop();
    }
  }
}