|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.lucene.search.Filter
org.apache.lucene.search.FieldValueFilter
public class FieldValueFilter
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.
| 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 |
|---|
public FieldValueFilter(String field)
FieldValueFilter
field - the field to filter
public FieldValueFilter(String field,
boolean negate)
FieldValueFilter
field - the field to filternegate - iff true all documents with no value in the given
field are accepted.| Method Detail |
|---|
public String field()
public boolean negate()
true iff this filter is negated, otherwise false
true iff this filter is negated, otherwise false
public DocIdSet getDocIdSet(IndexReader reader)
throws IOException
FilterDocIdSet 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.
getDocIdSet in class Filterreader - 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.
IOExceptionDocIdBitSetpublic int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class Objectpublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||