org.apache.solr.search

Class BitDocSet

java.lang.Object

org.apache.solr.search.BitDocSet

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable, DocSet

public class BitDocSet
extends Object

BitDocSet represents an unordered set of Lucene Document Ids using a BitSet. A set bit represents inclusion in the set for that document.

Since:

solr 0.9

Field Summary

Fields inherited from interface org.apache.solr.search.DocSet

EMPTY

Constructor Summary

Constructors

Constructor and Description
BitDocSet()
BitDocSet(FixedBitSet bits) Construct a BitDocSet.
BitDocSet(FixedBitSet bits, int size) Construct a BitDocSet, and provides the number of set bits.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int doc) Adds the specified document if it is not currently in the DocSet (optional operation).
void	addAllTo(DocSet target) Adds all the docs from this set to the target set.
void	addUnique(int doc) Adds a document the caller knows is not currently in the DocSet (optional operation).
DocSet	andNot(DocSet other) Returns the documents in this set that are not in the other set.
int	andNotSize(DocSet other) Returns the number of documents in this set that are not in the other set.
protected BitDocSet	clone()
void	close() FUTURE: for off-heap
boolean	equals(Object obj)
boolean	exists(int doc) Returns true of the doc exists in the set.
FixedBitSet	getBits() Return a FixedBitSet with a bit set for every document in this DocSet.
Collection<Accountable>	getChildResources()
Filter	getTopFilter() Returns a Filter for use in Lucene search methods, assuming this DocSet was generated from the top-level MultiReader that the Lucene search methods will be invoked with.
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.
boolean	intersects(DocSet other) Returns true if these sets have any elements in common
void	invalidateSize() The number of set bits - size - is cached.
DocIterator	iterator() Returns an iterator that may be used to iterate over all of the documents in the set.
long	ramBytesUsed()
int	size() Returns the number of documents in the set.
static FixedBitSet	toBitSet(DocSet set)
DocSet	union(DocSet other) Returns the union of this set with another set.
int	unionSize(DocSet other) Returns the number of documents of the union of this set with another set.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BitDocSet

public BitDocSet()

BitDocSet

public BitDocSet(FixedBitSet bits)

Construct a BitDocSet. The capacity of the FixedBitSet should be at least maxDoc()

BitDocSet

public BitDocSet(FixedBitSet bits,
         int size)

Construct a BitDocSet, and provides the number of set bits. The capacity of the FixedBitSet should be at least maxDoc()

Method Detail

iterator

public DocIterator iterator()

Description copied from interface: DocSet

Returns an iterator that may be used to iterate over all of the documents in the set.

The order of the documents returned by this iterator is non-deterministic, and any scoring information is meaningless

getBits

public FixedBitSet getBits()

Return a FixedBitSet with a bit set for every document in this DocSet. The default implementation iterates on all docs and sets the relevant bits. You should override if you can provide a more efficient implementation.

Returns:

the internal FixedBitSet that should not be modified.

add

public void add(int doc)

Description copied from interface: DocSet

Adds the specified document if it is not currently in the DocSet (optional operation).

Specified by:

add in interface DocSet

See Also:

DocSet.addUnique(int)

addUnique

public void addUnique(int doc)

Description copied from interface: DocSet

Adds a document the caller knows is not currently in the DocSet (optional operation).

This method may be faster then add(doc) in some implementaions provided the caller is certain of the precondition.

Specified by:

addUnique in interface DocSet

See Also:

DocSet.add(int)

size

public int size()

Description copied from interface: DocSet

Returns the number of documents in the set.

invalidateSize

public void invalidateSize()

The number of set bits - size - is cached. If the bitset is changed externally, this method should be used to invalidate the previously cached size.

exists

public boolean exists(int doc)

Returns true of the doc exists in the set. Should only be called when doc < FixedBitSet.length().

intersectionSize

public int intersectionSize(DocSet other)

Description copied from interface: DocSet

Returns the number of documents of the intersection of this set with another set. May be more efficient than actually creating the intersection and then getting its size.

Specified by:

intersectionSize in interface DocSet

intersects

public boolean intersects(DocSet other)

Description copied from interface: DocSet

Returns true if these sets have any elements in common

Specified by:

intersects in interface DocSet

unionSize

public int unionSize(DocSet other)

Description copied from interface: DocSet

Returns the number of documents of the union of this set with another set. May be more efficient than actually creating the union and then getting its size.

Specified by:

unionSize in interface DocSet

andNotSize

public int andNotSize(DocSet other)

Description copied from interface: DocSet

Returns the number of documents in this set that are not in the other set.

Specified by:

andNotSize in interface DocSet

addAllTo

public void addAllTo(DocSet target)

Description copied from interface: DocSet

Adds all the docs from this set to the target set. The target should be sized large enough to accommodate all of the documents before calling this method.

Specified by:

addAllTo in interface DocSet

andNot

public DocSet andNot(DocSet other)

Description copied from interface: DocSet

Returns the documents in this set that are not in the other set. Neither set is modified - a new DocSet is created and returned.

Specified by:

andNot in interface DocSet

Returns:

a DocSet representing this AND NOT other

union

public DocSet union(DocSet other)

Description copied from interface: DocSet

Returns the union of this set with another set. Neither set is modified - a new DocSet is created and returned.

Specified by:

union in interface DocSet

Returns:

a DocSet representing the union

clone

protected BitDocSet clone()

Overrides:

clone in class Object

getTopFilter

public Filter getTopFilter()

Description copied from interface: DocSet

Returns a Filter for use in Lucene search methods, assuming this DocSet was generated from the top-level MultiReader that the Lucene search methods will be invoked with.

Specified by:

getTopFilter in interface DocSet

ramBytesUsed

public long ramBytesUsed()

getChildResources

public Collection<Accountable> getChildResources()

toBitSet

public static FixedBitSet toBitSet(DocSet set)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

intersection

public DocSet intersection(DocSet other)

Description copied from interface: DocSet

Returns the intersection of this set with another set. Neither set is modified - a new DocSet is created and returned.

Specified by:

intersection in interface DocSet

Returns:

a DocSet representing the intersection

close

public void close()
           throws IOException

FUTURE: for off-heap

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException