Package 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
AFilter
that accepts all documents that have one or more values in a given field. ThisFilter
requestBits
from theFieldCache
and build the bits if not present.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description FieldValueFilter(String field)
Creates a newFieldValueFilter
FieldValueFilter(String field, boolean negate)
Creates a newFieldValueFilter
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
String
field()
Returns the field this filter is applied on.DocIdSet
getDocIdSet(IndexReader reader)
Creates aDocIdSet
enumerating the documents that should be permitted in search results.int
hashCode()
boolean
negate()
Returnstrue
iff this filter is negated, otherwisefalse
String
toString()
-
-
-
Constructor Detail
-
FieldValueFilter
public FieldValueFilter(String field)
Creates a newFieldValueFilter
- Parameters:
field
- the field to filter
-
FieldValueFilter
public FieldValueFilter(String field, boolean negate)
Creates a newFieldValueFilter
- Parameters:
field
- the field to filternegate
- ifftrue
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()
Returnstrue
iff this filter is negated, otherwisefalse
- Returns:
true
iff this filter is negated, otherwisefalse
-
getDocIdSet
public DocIdSet getDocIdSet(IndexReader reader) throws IOException
Description copied from class:Filter
Creates aDocIdSet
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 classFilter
- Parameters:
reader
- aIndexReader
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
-
-