Package org.apache.lucene.search

Class KnnVectorQuery.DocAndScoreQuery

  • Enclosing class:
    KnnVectorQuery
    static class KnnVectorQuery.DocAndScoreQuery
extends Query
    Caches the results of a KnnVector search: a list of docs and their scores

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Object contextIdentity  
      private int[] docs  
      private int k  
      private float[] scores  
      private int[] segmentStarts  

    • Constructor Summary

      Constructors 
      Constructor Description
      DocAndScoreQuery​(int k, int[] docs, float[] scores, int[] segmentStarts, java.lang.Object contextIdentity)
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Weight createWeight​(IndexSearcher searcher, ScoreMode scoreMode, float boost)
      Expert: Constructs an appropriate Weight implementation for this query.
      boolean equals​(java.lang.Object obj)
      Override and implement query instance equivalence properly in a subclass.
      int hashCode()
      Override and implement query hash code properly in a subclass.
      java.lang.String toString​(java.lang.String field)
      Prints a query to a string, with field assumed to be the default field and omitted.
      void visit​(QueryVisitor visitor)
      Recurse through the query tree, visiting any child queries

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • k

        private final int k

      • docs

        private final int[] docs

      • scores

        private final float[] scores

      • segmentStarts

        private final int[] segmentStarts

      • contextIdentity

        private final java.lang.Object contextIdentity

    • Constructor Detail

      • DocAndScoreQuery

        DocAndScoreQuery​(int k,
                 int[] docs,
                 float[] scores,
                 int[] segmentStarts,
                 java.lang.Object contextIdentity)
        Constructor
        Parameters:
        k - the number of documents requested
        docs - the global docids of documents that match, in ascending order
        scores - the scores of the matching documents
        segmentStarts - the indexes in docs and scores corresponding to the first matching document in each segment. If a segment has no matching documents, it should be assigned the index of the next segment that does. There should be a final entry that is always docs.length-1.
        contextIdentity - an object identifying the reader context that was used to build this query

    • Method Detail

      • createWeight

        public Weight createWeight​(IndexSearcher searcher,
                           ScoreMode scoreMode,
                           float boost)
                    throws java.io.IOException
        Description copied from class: Query
        Expert: Constructs an appropriate Weight implementation for this query.

        Only implemented by primitive queries, which re-write to themselves.

        Overrides:
        createWeight in class Query
        scoreMode - How the produced scorers will be consumed.
        boost - The boost that is propagated by the parent queries.
        Throws:
        java.io.IOException

      • toString

        public java.lang.String toString​(java.lang.String field)
        Description copied from class: Query
        Prints a query to a string, with field assumed to be the default field and omitted.
        Specified by:
        toString in class Query

      • visit

        public void visit​(QueryVisitor visitor)
        Description copied from class: Query
        Recurse through the query tree, visiting any child queries
        Specified by:
        visit in class Query
        Parameters:
        visitor - a QueryVisitor to be called by each query in the tree

      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from class: Query
        Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

        Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.

        Specified by:
        equals in class Query
        See Also:
        Query.sameClassAs(Object), Query.classHash()

      • hashCode

        public int hashCode()
        Description copied from class: Query
        Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.
        Specified by:
        hashCode in class Query
        See Also:
        Query.equals(Object)