Class Weight

    • Constructor Detail

      • Weight

        public Weight()
    • Method Detail

      • explain

        public abstract Explanation explain​(AtomicReaderContext context,
                                            int doc)
                                     throws IOException
        An explanation of the score computation for the named document.
        context - the readers context to create the Explanation for.
        doc - the document's id relative to the given context's reader
        an Explanation for the score
        IOException - if an IOException occurs
      • getQuery

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

        public abstract float getValueForNormalization()
                                                throws IOException
        The value for normalization of contained query clauses (e.g. sum of squared weights).
      • normalize

        public abstract void normalize​(float norm,
                                       float topLevelBoost)
        Assigns the query normalization factor and boost from parent queries to this.
      • scorer

        public abstract Scorer scorer​(AtomicReaderContext context,
                                      boolean scoreDocsInOrder,
                                      boolean topScorer,
                                      Bits acceptDocs)
                               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.

        context - the AtomicReaderContext 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.
        acceptDocs - Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)
        a Scorer which scores documents in/out-of order.
        IOException - if there is a low-level I/O error