Class DocSlice

  • All Implemented Interfaces:
    org.apache.lucene.util.Accountable, DocList

    public class DocSlice
    extends Object
    implements DocList, org.apache.lucene.util.Accountable
    DocSlice implements DocList as an array of docids and optional scores.
    solr 0.9
    • Field Summary

      • Fields inherited from interface org.apache.lucene.util.Accountable

    • Constructor Summary

      Constructor Description
      DocSlice​(int offset, int len, int[] docs, float[] scores, long matches, float maxScore, matchesRelation)
      Primary constructor for a DocSlice instance.
    • Constructor Detail

      • DocSlice

        public DocSlice​(int offset,
                        int len,
                        int[] docs,
                        float[] scores,
                        long matches,
                        float maxScore,
        Primary constructor for a DocSlice instance.
        offset - starting offset for this range of docs
        len - length of results
        docs - array of docids starting at position 0
        scores - array of scores that corresponds to docs, may be null
        matches - total number of matches for the query
        matchesRelation - Indicates if matches is exact or an approximation
    • Method Detail

      • subset

        public DocList subset​(int offset,
                              int len)
        Description copied from interface: DocList
        Get a subset of an existing DocList. Returns null if not possible.
        Specified by:
        subset in interface DocList
      • hasScores

        public boolean hasScores()
        Description copied from interface: DocList
        True if scores were retained
        Specified by:
        hasScores in interface DocList
      • maxScore

        public float maxScore()
        Description copied from interface: DocList
        The maximum score for the search... only valid if scores were retained (if hasScores()==true)
        Specified by:
        maxScore in interface DocList
      • offset

        public int offset()
        Description copied from interface: DocList
        Returns the zero based offset of this list within the total ordered list of matches to the query.
        Specified by:
        offset in interface DocList
      • size

        public int size()
        Description copied from interface: DocList
        Returns the number of ids in this list.
        Specified by:
        size in interface DocList
      • matches

        public long matches()
        Description copied from interface: DocList
        Returns the total number of matches for the search (as opposed to just the number collected according to offset() and size()). Hence it's always true that matches() >= size()
        Specified by:
        matches in interface DocList
        number of matches for the search(query & any filters)
      • iterator

        public DocIterator iterator()
        Description copied from interface: DocList
        Returns an iterator that may be used to iterate over the documents in this DocList

        The order of the documents returned by this iterator is based on the Sort order of the search that produced it. The Scoring information is meaningful only if hasScores() returns true.

        Specified by:
        iterator in interface DocList
        See Also:
      • ramBytesUsed

        public long ramBytesUsed()
        WARNING: this can over-estimate real memory use since backing arrays are shared with other DocSlice instances
        Specified by:
        ramBytesUsed in interface org.apache.lucene.util.Accountable
      • getChildResources

        public Collection<org.apache.lucene.util.Accountable> getChildResources()
        Specified by:
        getChildResources in interface org.apache.lucene.util.Accountable
      • hitCountRelation

        public hitCountRelation()
        Specified by:
        hitCountRelation in interface DocList