|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.search.Filter
com.jivesoftware.util.search.MultiFilter
public class MultiFilter
A Filter that logically combines multiple other Filters. An arbitrary number of Filter objects can be added to each MultiFilter. MultiFilters may combine there component filters either by AND'ing them or OR'ing them, i.e., when a Query is executed with a MultiFilter, each Document in the HitList must pass either every or any Filter in the MultiFilter filter list.
For example, consider an AND MultiFilter that is created with a FilterX filter and FilterY filter. When a search is executed with the MultiFilter, in order for Document A to appear in the results, it must pass both the FilterX and FilterY filters. On the other hand, if an OR MultiFilter is created the same filters, Document A will appear in the results if it passes either the FilterX or FilterY filters or both.
If no Filter objects are added to a MultiFilter before it is used in a search, this will have the affect of filtering out all search results.
Nested Class Summary | |
---|---|
static class |
MultiFilter.FilterType
|
Constructor Summary | |
---|---|
MultiFilter()
Creates a new MultiFilter. |
|
MultiFilter(int initialCapacity)
Creates a new MultiFilter with the specified initial capacity. |
|
MultiFilter(int initialCapacity,
MultiFilter.FilterType filterType)
Creates a new MultiFilter with the specified initial capacity. |
|
MultiFilter(MultiFilter.FilterType filterType)
|
Method Summary | |
---|---|
void |
add(org.apache.lucene.search.Filter filter)
Adds a filter to the MuliFilter filter list. |
java.util.BitSet |
bits(org.apache.lucene.index.IndexReader reader)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MultiFilter()
public MultiFilter(MultiFilter.FilterType filterType)
public MultiFilter(int initialCapacity)
initialCapacity
- an initial capacity size for the MultiFilter.public MultiFilter(int initialCapacity, MultiFilter.FilterType filterType)
initialCapacity
- an initial capacity size for the MultiFilter.Method Detail |
---|
public void add(org.apache.lucene.search.Filter filter)
filter
- a Filter to add to the MultiFilter filter list.public java.util.BitSet bits(org.apache.lucene.index.IndexReader reader) throws java.io.IOException
bits
in class org.apache.lucene.search.Filter
java.io.IOException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |