public class DocSlice extends DocSetBase implements DocList
DocSlice
implements DocList as an array of docids and optional scores.Modifier and Type | Field and Description |
---|---|
(package private) int[] |
docs |
(package private) int |
len |
(package private) int |
matches |
(package private) float |
maxScore |
(package private) int |
offset |
(package private) float[] |
scores |
Constructor and Description |
---|
DocSlice(int offset,
int len,
int[] docs,
float[] scores,
int matches,
float maxScore)
Primary constructor for a DocSlice instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
exists(int doc)
Returns true if a document is in the DocSet.
|
boolean |
hasScores()
True if scores were retained
|
DocSet |
intersection(DocSet other)
Returns the intersection of this set with another set.
|
int |
intersectionSize(DocSet other)
Returns the number of documents of the intersection of this set with another set.
|
DocIterator |
iterator()
Returns an iterator that may be used to iterate over the documents in this DocList
|
int |
matches()
Returns the total number of matches for the search
(as opposed to just the number collected according
to
offset() and size() ). |
float |
maxScore()
The maximum score for the search...
|
long |
memSize()
Returns the approximate amount of memory taken by this DocSet.
|
int |
offset()
Returns the zero based offset of this list within the total ordered list of matches to the query.
|
int |
size()
Returns the number of ids in this list.
|
DocList |
subset(int offset,
int len)
Get a subset of an existing DocList.
|
add, addUnique, andNot, andNotSize, equals, getBits, getTopFilter, union, unionSize
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
add, addUnique, andNot, andNotSize, getBits, getTopFilter, union, unionSize
final int offset
final int len
final int[] docs
final float[] scores
final int matches
final float maxScore
public DocSlice(int offset, int len, int[] docs, float[] scores, int matches, float maxScore)
offset
- starting offset for this range of docslen
- length of resultsdocs
- array of docids starting at position 0scores
- array of scores that corresponds to docs, may be nullmatches
- total number of matches for the querypublic DocList subset(int offset, int len)
DocList
public boolean hasScores()
DocList
public float maxScore()
DocList
public int offset()
DocList
public int size()
DocList
public int matches()
DocList
offset()
and size()
).
Hence it's always true that matches() >= size()public long memSize()
DocSet
public boolean exists(int doc)
DocSet
public DocIterator iterator()
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.
iterator
in interface DocList
iterator
in interface DocSet
DocList.hasScores()
public DocSet intersection(DocSet other)
DocSet
intersection
in interface DocSet
intersection
in class DocSetBase
public int intersectionSize(DocSet other)
DocSet
intersectionSize
in interface DocSet
intersectionSize
in class DocSetBase