Lucene.Net.Analysis.ChainedFilter Class Reference

More...

Inherits Lucene.Net.Search.Filter.

Public Types
enum	Logic {   NONE = -1, OR = 0, AND = 1, ANDNOT = 2,   XOR = 3 }

Public Member Functions
	ChainedFilter (Filter[] chain)
	ChainedFilter (Filter[] chain, Logic[] logicArray)
	ChainedFilter (Filter[] chain, Logic logic)
	see cref="Filter#getDocIdSet"/>
override DocIdSet	GetDocIdSet (IndexReader reader)
override String	ToString ()

Public Attributes
const Logic	DEFAULT = Logic.OR
	summary>Logical operation when none is declared. Defaults to OR

Protected Member Functions
DocIdSet	FinalResult (OpenBitSetDISI result, int maxDocs)

Detailed Description

• Allows multiple Filters 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.

/summary>

Definition at line 45 of file ChainedFilter.cs.

Member Enumeration Documentation

enum Lucene.Net.Analysis.ChainedFilter.Logic

Enumerator
NONE
OR
AND
ANDNOT
XOR

Definition at line 47 of file ChainedFilter.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.ChainedFilter.ChainedFilter

(

Filter[]

chain

)

summary>ctor

param name="chain">The chain of filters

param name="logicArray">Logical operations to apply between filters

Definition at line 67 of file ChainedFilter.cs.

Lucene.Net.Analysis.ChainedFilter.ChainedFilter	(	Filter[]	chain,
		Logic[]	logicArray
	)

summary>ctor

param name="chain">The chain of filters

param name="logic">Logical operation to apply to ALL filters

Definition at line 75 of file ChainedFilter.cs.

Lucene.Net.Analysis.ChainedFilter.ChainedFilter	(	Filter[]	chain,
		Logic	logic
	)

see cref="Filter#getDocIdSet"/>

Definition at line 84 of file ChainedFilter.cs.

Member Function Documentation

DocIdSet Lucene.Net.Analysis.ChainedFilter.FinalResult ( OpenBitSetDISI  result, int  maxDocs  )

protected

Definition at line 157 of file ChainedFilter.cs.

override DocIdSet Lucene.Net.Analysis.ChainedFilter.GetDocIdSet ( IndexReader  reader )

virtual

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.

/summary>

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.

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.

See Also

DocIdBitSet

Implements Lucene.Net.Search.Filter.

Definition at line 91 of file ChainedFilter.cs.

override String Lucene.Net.Analysis.ChainedFilter.ToString

(

)

Definition at line 198 of file ChainedFilter.cs.

Member Data Documentation

const Logic Lucene.Net.Analysis.ChainedFilter.DEFAULT = Logic.OR

summary>Logical operation when none is declared. Defaults to OR

Definition at line 57 of file ChainedFilter.cs.

---

The documentation for this class was generated from the following file:

• contrib/Analyzers/Filters/ChainedFilter.cs