Package org.apache.lucene.queries

Class TermFilter

java.lang.Object

org.apache.lucene.search.Filter

org.apache.lucene.queries.TermFilter

public final class TermFilter
extends Filter

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

Constructor Summary

Constructors

Constructor	Description
TermFilter(Term term)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
DocIdSet	getDocIdSet(AtomicReaderContext context, Bits acceptDocs)	Creates a DocIdSet enumerating the documents that should be permitted in search results.
Term	getTerm()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TermFilter

public TermFilter(Term term)

Parameters:

term - The term documents need to have in order to be a match for this filter.

Method Detail

getTerm

public Term getTerm()

Returns:

The term this filter includes documents with.

getDocIdSet

public DocIdSet getDocIdSet(AtomicReaderContext context,
                            Bits acceptDocs)
                     throws java.io.IOException

Description copied from class: Filter

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

Note: This method will be called once per segment in the index during searching. The returned DocIdSet must refer to document IDs for that segment, not for the top-level reader.

Specified by:

getDocIdSet in class Filter

Parameters:

context - a 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 AtomicReader.fields() on the context's reader, for example.

acceptDocs - Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)

Returns:

a 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 empty DocIdSet is returned.

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object