org.elasticsearch.common.lucene.search

Class XFilteredQuery

java.lang.Object

org.apache.lucene.search.Query

org.elasticsearch.common.lucene.search.XFilteredQuery

All Implemented Interfaces:

Cloneable

public final class XFilteredQuery
extends org.apache.lucene.search.Query

A query that applies a filter to the results of another query.

Note: the bits are retrieved from the filter each time this query is used in a search - use a CachingWrapperFilter to avoid regenerating the bits every time.

Since:

1.4

See Also:

CachingWrapperFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XFilteredQuery.CustomRandomAccessFilterStrategy Extends FilteredQuery.RandomAccessFilterStrategy.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.lucene.search.FilteredQuery.FilterStrategy	ALWAYS_RANDOM_ACCESS_FILTER_STRATEGY
static XFilteredQuery.CustomRandomAccessFilterStrategy	CUSTOM_FILTER_STRATEGY

Constructor Summary

Constructors

Constructor and Description
XFilteredQuery(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter) Constructs a new query which applies a filter to the results of the original query.
XFilteredQuery(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.FilteredQuery.FilterStrategy strategy) Expert: Constructs a new query which applies a filter to the results of the original query.

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Query	clone()
org.apache.lucene.search.Weight	createWeight(org.apache.lucene.search.IndexSearcher searcher) Returns a Weight that applies the filter to the enclosed query's Weight.
boolean	equals(Object o) Returns true iff o is equal to this.
void	extractTerms(Set<org.apache.lucene.index.Term> terms)
float	getBoost()
org.apache.lucene.search.Filter	getFilter() Returns this FilteredQuery's filter
org.apache.lucene.search.Query	getQuery() Returns this FilteredQuery's (unfiltered) Query
int	hashCode() Returns a hash code value for this object.
org.apache.lucene.search.Query	rewrite(org.apache.lucene.index.IndexReader reader) Rewrites the query.
void	setBoost(float b)
String	toString(String s) Prints a user-readable version of this query.

Methods inherited from class org.apache.lucene.search.Query

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALWAYS_RANDOM_ACCESS_FILTER_STRATEGY

public static final org.apache.lucene.search.FilteredQuery.FilterStrategy ALWAYS_RANDOM_ACCESS_FILTER_STRATEGY

CUSTOM_FILTER_STRATEGY

public static final XFilteredQuery.CustomRandomAccessFilterStrategy CUSTOM_FILTER_STRATEGY

Constructor Detail

XFilteredQuery

public XFilteredQuery(org.apache.lucene.search.Query query,
                      org.apache.lucene.search.Filter filter)

Constructs a new query which applies a filter to the results of the original query. Filter.getDocIdSet(org.apache.lucene.index.AtomicReaderContext, org.apache.lucene.util.Bits) will be called every time this query is used in a search.

Parameters:

query - Query to be filtered, cannot be null.

filter - Filter to apply to query results, cannot be null.

XFilteredQuery

public XFilteredQuery(org.apache.lucene.search.Query query,
                      org.apache.lucene.search.Filter filter,
                      org.apache.lucene.search.FilteredQuery.FilterStrategy strategy)

Expert: Constructs a new query which applies a filter to the results of the original query. Filter.getDocIdSet(org.apache.lucene.index.AtomicReaderContext, org.apache.lucene.util.Bits) will be called every time this query is used in a search.

Parameters:

query - Query to be filtered, cannot be null.

filter - Filter to apply to query results, cannot be null.

strategy - a filter strategy used to create a filtered scorer.

See Also:

FilteredQuery.FilterStrategy

Method Detail

createWeight

public org.apache.lucene.search.Weight createWeight(org.apache.lucene.search.IndexSearcher searcher)
                                             throws IOException

Returns a Weight that applies the filter to the enclosed query's Weight. This is accomplished by overriding the Scorer returned by the Weight.

Overrides:

createWeight in class org.apache.lucene.search.Query

Throws:

IOException

rewrite

public org.apache.lucene.search.Query rewrite(org.apache.lucene.index.IndexReader reader)
                                       throws IOException

Rewrites the query. If the wrapped is an instance of MatchAllDocsQuery it returns a ConstantScoreQuery. Otherwise it returns a new FilteredQuery wrapping the rewritten query.

Overrides:

rewrite in class org.apache.lucene.search.Query

Throws:

IOException

setBoost

public void setBoost(float b)

Overrides:

setBoost in class org.apache.lucene.search.Query

getBoost

public float getBoost()

Overrides:

getBoost in class org.apache.lucene.search.Query

getQuery

public final org.apache.lucene.search.Query getQuery()

Returns this FilteredQuery's (unfiltered) Query

getFilter

public final org.apache.lucene.search.Filter getFilter()

Returns this FilteredQuery's filter

extractTerms

public void extractTerms(Set<org.apache.lucene.index.Term> terms)

Overrides:

extractTerms in class org.apache.lucene.search.Query

toString

public String toString(String s)

Prints a user-readable version of this query.

Specified by:

toString in class org.apache.lucene.search.Query

equals

public boolean equals(Object o)

Returns true iff o is equal to this.

Overrides:

equals in class org.apache.lucene.search.Query

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class org.apache.lucene.search.Query

clone

public org.apache.lucene.search.Query clone()

Overrides:

clone in class org.apache.lucene.search.Query