org.apache.lucene.search
Class SpanQueryFilter

java.lang.Object
  extended by org.apache.lucene.search.Filter
      extended by org.apache.lucene.search.SpanFilter
          extended by org.apache.lucene.search.SpanQueryFilter
All Implemented Interfaces:
java.io.Serializable

public class SpanQueryFilter
extends SpanFilter

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.

See Also:
Serialized Form

Field Summary
protected  SpanQuery query
           
 
Constructor Summary
protected SpanQueryFilter()
           
  SpanQueryFilter(SpanQuery query)
          Constructs a filter which only matches documents matching query.
 
Method Summary
 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(java.lang.Object o)
           
 DocIdSet getDocIdSet(IndexReader reader)
           
 SpanQuery getQuery()
           
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class org.apache.lucene.search.Filter
bits
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

query

protected SpanQuery query
Constructor Detail

SpanQueryFilter

protected SpanQueryFilter()

SpanQueryFilter

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.
Method Detail

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws java.io.IOException
Overrides:
getDocIdSet in class Filter
Returns:
a DocIdSet that provides the documents which should be permitted or prohibited in search results.
Throws:
java.io.IOException
See Also:
DocIdBitSet

bitSpans

public SpanFilterResult bitSpans(IndexReader reader)
                          throws java.io.IOException
Description copied from class: SpanFilter
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.

Specified by:
bitSpans in class SpanFilter
Parameters:
reader - The IndexReader to load position and DocIdSet information from
Returns:
A SpanFilterResult
Throws:
java.io.IOException - if there was an issue accessing the necessary information

getQuery

public SpanQuery getQuery()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object