Class Weight

    • Constructor Detail

      • Weight

        public Weight()
    • Method Detail

      • explain

        public abstract Explanation explain​(IndexReader reader,
                                            int doc)
                                     throws IOException
        An explanation of the score computation for the named document.
        Parameters:
        reader - sub-reader containing the give doc
        doc -
        Returns:
        an Explanation for the score
        Throws:
        IOException
      • getQuery

        public abstract Query getQuery()
        The query that this concerns.
      • getValue

        public abstract float getValue()
        The weight for this query.
      • normalize

        public abstract void normalize​(float norm)
        Assigns the query normalization factor to this.
      • scorer

        public abstract Scorer scorer​(IndexReader reader,
                                      boolean scoreDocsInOrder,
                                      boolean topScorer)
                               throws IOException
        Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

        NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call scoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.
        NOTE: null can be returned if no documents will be scored by this query.

        Parameters:
        reader - the IndexReader for which to return the Scorer.
        scoreDocsInOrder - specifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not support DocIdSetIterator.nextDoc() and/or DocIdSetIterator.advance(int), therefore it is recommended to request an in-order scorer if use of these methods is required.
        topScorer - if true, Scorer.score(Collector) will be called; if false, DocIdSetIterator.nextDoc() and/or DocIdSetIterator.advance(int) will be called.
        Returns:
        a Scorer which scores documents in/out-of order.
        Throws:
        IOException
      • sumOfSquaredWeights

        public abstract float sumOfSquaredWeights()
                                           throws IOException
        The sum of squared weights of contained query clauses.
        Throws:
        IOException