Class TermFilter

A filter that includes documents that match with a specific term.

Inheritance

object

Filter

TermFilter

Inherited Members

Filter.NewAnonymous(Func<AtomicReaderContext, IBits, DocIdSet>)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Queries

Assembly: Lucene.Net.Queries.dll

Syntax

public sealed class TermFilter : Filter

Constructors

TermFilter(Term)

A filter that includes documents that match with a specific term.

Declaration

public TermFilter(Term term)

Parameters

Type	Name	Description
Term	term	The term documents need to have in order to be a match for this filter.

Properties

Term

Gets the term this filter includes documents with.

Declaration

public Term Term { get; }

Property Value

Type	Description
Term

Methods

Equals(object)

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

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
object	o

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

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

object.GetHashCode()

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

object.ToString()