public class

MultiTermFilter

extends Filter
java.lang.Object
   ↳ org.apache.lucene.search.Filter
     ↳ com.atlassian.confluence.search.lucene.filter.MultiTermFilter

Class Overview

Lucene filter that finds documents that match any of the supplied org.apache.lucene.index.Term. (This filter basically applies an OR operation on each of the terms.)

Summary

Public Constructors
MultiTermFilter()
Create a new MultiTermFilter with a default behaviour of not negating.
MultiTermFilter(boolean negating)
Create a new MultiTermFilter with control over whether it is negating or not.
Public Methods
void addTerm(Term term)
BitSet bits(IndexReader reader)
[Expand]
Inherited Methods
From class org.apache.lucene.search.Filter
From class java.lang.Object

Public Constructors

public MultiTermFilter ()

Create a new MultiTermFilter with a default behaviour of not negating.

See Also

public MultiTermFilter (boolean negating)

Create a new MultiTermFilter with control over whether it is negating or not.

Parameters
negating if true then the filter will have a starting state of allowing all documents with any matching terms causing that document not to match. If false, then the filter behaves as you would normally expect with no documents being allowed unless they match the filter.

Public Methods

public void addTerm (Term term)

Parameters
term one of the terms to be part of the filter.
Throws
IllegalArgumentException if the null term parameter is supplied

public BitSet bits (IndexReader reader)

Throws
IOException