org.apache.lucene.search
Class FieldValueFilter

java.lang.Object
  org.apache.lucene.search.Filter
      org.apache.lucene.search.FieldValueFilter

All Implemented Interfaces:

Serializable

public class FieldValueFilter
extends Filter

A Filter that accepts all documents that have one or more values in a given field. This Filter request Bits from the FieldCache and build the bits if not present.

See Also:

Serialized Form

Constructor Summary

FieldValueFilter(String field)
Creates a new FieldValueFilter

FieldValueFilter(String field, boolean negate)
Creates a new FieldValueFilter

Method Summary

boolean	equals(Object obj)
String	field() Returns the field this filter is applied on.
DocIdSet	getDocIdSet(IndexReader reader) Creates a DocIdSet enumerating the documents that should be permitted in search results.
int	hashCode()
boolean	negate() Returns true iff this filter is negated, otherwise false
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldValueFilter

public FieldValueFilter(String field)

Creates a new FieldValueFilter

Parameters:

field - the field to filter

FieldValueFilter

public FieldValueFilter(String field,
                        boolean negate)

Creates a new FieldValueFilter

Parameters:

field - the field to filter

negate - iff true all documents with no value in the given field are accepted.

Method Detail

field

public String field()

Returns the field this filter is applied on.

Returns:

the field this filter is applied on.

negate

public boolean negate()

Returns true iff this filter is negated, otherwise false

Returns:

true iff this filter is negated, otherwise false

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws 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:

reader - a IndexReader instance opened on the index currently searched on. Note, it is likely that the provided reader 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.

Returns:

a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null can be returned if no documents will be accepted by this Filter.

Throws:

IOException

See Also:

DocIdBitSet

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object