public class

SpanQueryFilter

extends SpanFilter
java.lang.Object
   ↳ org.apache.lucene.search.Filter
     ↳ org.apache.lucene.search.SpanFilter
       ↳ org.apache.lucene.search.SpanQueryFilter

Class Overview

Constrains search results to only match those which also match a provided query. Also provides position information about where each document matches at the cost of extra space compared with the QueryWrapperFilter. There is an added cost to this above what is stored in a QueryWrapperFilter. Namely, the position information for each matching document is stored.

This filter does not cache. See the CachingSpanFilter for a wrapper that caches.

Summary

Fields
protected SpanQuery query
Public Constructors
SpanQueryFilter(SpanQuery query)
Constructs a filter which only matches documents matching query.
Protected Constructors
SpanQueryFilter()
Public Methods
SpanFilterResult bitSpans(IndexReader reader)
Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.
boolean equals(Object o)
DocIdSet getDocIdSet(IndexReader reader)
Creates a DocIdSet enumerating the documents that should be permitted in search results.
SpanQuery getQuery()
int hashCode()
String toString()
[Expand]
Inherited Methods
From class org.apache.lucene.search.SpanFilter
From class org.apache.lucene.search.Filter
From class java.lang.Object

Fields

protected SpanQuery query

Public Constructors

public SpanQueryFilter (SpanQuery query)

Constructs a filter which only matches documents matching query.

Parameters
query The SpanQuery to use as the basis for the Filter.

Protected Constructors

protected SpanQueryFilter ()

Public Methods

public SpanFilterResult bitSpans (IndexReader reader)

Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.

Parameters
reader The IndexReader to load position and DocIdSet information from
Returns
Throws
IOException

public boolean equals (Object o)

public DocIdSet getDocIdSet (IndexReader reader)

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.

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.
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.
Throws
IOException

public SpanQuery getQuery ()

public int hashCode ()

public String toString ()