Class TermsFilter

Constructs a filter for docs matching any of the terms added to this class. Unlike a RangeFilter this can be used for filtering on multiple terms that are not necessarily in a sequence. An example might be a collection of primary keys from a database query result or perhaps a choice of "category" labels picked by the end user. As a filter, this is much faster than the equivalent query (a Lucene.Net.Search.BooleanQuery with many "should" Lucene.Net.Search.TermQuerys)

Inheritance
object
Filter
TermsFilter
Inherited Members
Namespace: Lucene.Net.Queries
Assembly: Lucene.Net.Queries.dll
Syntax
public sealed class TermsFilter : Filter

Constructors

TermsFilter(params Term[])

Creates a new TermsFilter from the given array. The array can contain duplicate terms and multiple fields.

Declaration
public TermsFilter(params Term[] terms)
Parameters
Type Name Description
Term[] terms

TermsFilter(IList<Term>)

Creates a new TermsFilter from the given list. The list can contain duplicate terms and multiple fields.

Declaration
public TermsFilter(IList<Term> terms)
Parameters
Type Name Description
IList<Term> terms

TermsFilter(string, params BytesRef[])

Creates a new TermsFilter from the given Lucene.Net.Util.BytesRef array for a single field.

Declaration
public TermsFilter(string field, params BytesRef[] terms)
Parameters
Type Name Description
string field
BytesRef[] terms

TermsFilter(string, IList<BytesRef>)

Creates a new TermsFilter from the given Lucene.Net.Util.BytesRef list for a single field.

Declaration
public TermsFilter(string field, IList<BytesRef> terms)
Parameters
Type Name Description
string field
IList<BytesRef> terms

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetDocIdSet(AtomicReaderContext, IBits)

Creates a Lucene.Net.Search.DocIdSet enumerating the documents that should be permitted in search results. NOTE:null can be returned if no documents are accepted by this Lucene.Net.Search.Filter.

Note: this method will be called once per segment in the index during searching. The returned Lucene.Net.Search.DocIdSet must refer to document IDs for that segment, not for the top-level reader.
Declaration
public override DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)
Parameters
Type Name Description
AtomicReaderContext context

a Lucene.Net.Index.AtomicReaderContext instance opened on the index currently searched on. Note, it is likely that the provided reader info does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment. The provided context is always an atomic context, so you can call Lucene.Net.Index.AtomicReader.Fields on the context's reader, for example.
IBits acceptDocs

Lucene.Net.Util.IBits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)
Returns
Type Description
DocIdSet

A Lucene.Net.Search.DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE:null should be returned if the filter doesn't accept any documents otherwise internal optimization might not apply in the case an emptyLucene.Net.Search.DocIdSet is returned.
Overrides
Lucene.Net.Search.Filter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext, Lucene.Net.Util.IBits)

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides