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 and Description
TermFilter(Term term)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
DocIdSet	getDocIdSet(LeafReaderContext context, Bits acceptDocs)
Term	getTerm()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, 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(LeafReaderContext context,
                   Bits acceptDocs)
                     throws IOException

Specified by:

getDocIdSet in class Filter

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object