org.apache.lucene.search
Class PrefixFilter

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

public class PrefixFilter
extends Filter

Version:
$Id$
See Also:
Serialized Form

Field Summary
protected  Term prefix
           
 
Constructor Summary
PrefixFilter(Term prefix)
           
 
Method Summary
 java.util.BitSet bits(IndexReader reader)
          Deprecated. Use getDocIdSet(IndexReader) instead.
 DocIdSet getDocIdSet(IndexReader reader)
           
 Term getPrefix()
           
 java.lang.String toString()
          Prints a user-readable version of this query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

prefix

protected final Term prefix
Constructor Detail

PrefixFilter

public PrefixFilter(Term prefix)
Method Detail

getPrefix

public Term getPrefix()

bits

public java.util.BitSet bits(IndexReader reader)
                      throws java.io.IOException
Deprecated. Use getDocIdSet(IndexReader) instead.

Overrides:
bits in class Filter
Returns:
A BitSet with true for documents which should be permitted in search results, and false for those that should not.
Throws:
java.io.IOException

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

toString

public java.lang.String toString()
Prints a user-readable version of this query.

Overrides:
toString in class java.lang.Object


Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.