Package org.apache.lucene.queries
Class ChainedFilter
- java.lang.Object
-
- org.apache.lucene.search.Filter
-
- org.apache.lucene.queries.ChainedFilter
-
public class ChainedFilter extends Filter
Allows multiple
Filter
s to be chained. Logical operations such as NOT and XOR are applied between filters. One operation can be used for all filters, or a specific operation can be declared for each filter.Order in which filters are called depends on the position of the filter in the chain. It's probably more efficient to place the most restrictive filters /least computationally-intensive filters first.
-
-
Constructor Summary
Constructors Constructor Description ChainedFilter(Filter[] chain)
Ctor.ChainedFilter(Filter[] chain, int logic)
Ctor.ChainedFilter(Filter[] chain, int[] logicArray)
Ctor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocIdSet
getDocIdSet(AtomicReaderContext context, Bits acceptDocs)
String
toString()
-
-
-
Field Detail
-
OR
public static final int OR
- See Also:
- Constant Field Values
-
AND
public static final int AND
- See Also:
- Constant Field Values
-
ANDNOT
public static final int ANDNOT
- See Also:
- Constant Field Values
-
XOR
public static final int XOR
- See Also:
- Constant Field Values
-
DEFAULT
public static final int DEFAULT
Logical operation when none is declared. Defaults to OR.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ChainedFilter
public ChainedFilter(Filter[] chain)
Ctor.- Parameters:
chain
- The chain of filters
-
ChainedFilter
public ChainedFilter(Filter[] chain, int[] logicArray)
Ctor.- Parameters:
chain
- The chain of filterslogicArray
- Logical operations to apply between filters
-
ChainedFilter
public ChainedFilter(Filter[] chain, int logic)
Ctor.- Parameters:
chain
- The chain of filterslogic
- Logical operation to apply to ALL filters
-
-
Method Detail
-
getDocIdSet
public DocIdSet getDocIdSet(AtomicReaderContext context, Bits acceptDocs) throws IOException
- Specified by:
getDocIdSet
in classFilter
- Parameters:
context
- aAtomicReaderContext
instance opened on the index currently searched on. Note, it is likely that the provided reader info 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. The provided context is always an atomic context, so you can callAtomicReader.fields()
on the context's reader, for example.acceptDocs
- Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)- Returns:
- a DocIdSet that provides the documents which should be permitted or
prohibited in search results. NOTE:
null
should be returned if the filter doesn't accept any documents otherwise internal optimization might not apply in the case an emptyDocIdSet
is returned. - Throws:
IOException
-
-