|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.index.IndexReader
org.apache.lucene.index.FilterIndexReader
A FilterIndexReader
contains another IndexReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. The class
FilterIndexReader
itself simply implements all abstract methods
of IndexReader
with versions that pass all requests to the
contained index reader. Subclasses of FilterIndexReader
may
further override some of these methods and may also provide additional
methods and fields.
Nested Class Summary | |
static class |
FilterIndexReader.FilterTermDocs
Base class for filtering TermDocs implementations. |
static class |
FilterIndexReader.FilterTermEnum
Base class for filtering TermEnum implementations. |
static class |
FilterIndexReader.FilterTermPositions
Base class for filtering TermPositions implementations. |
Field Summary | |
protected IndexReader |
in
|
Constructor Summary | |
FilterIndexReader(IndexReader in)
|
Method Summary | |
int |
docFreq(Term t)
Returns the number of documents containing the term t . |
protected void |
doClose()
Implements close. |
Document |
document(int n)
Returns the stored fields of the n th
Document in this index. |
protected void |
doDelete(int n)
Implements deletion of the document numbered docNum . |
Collection |
getFieldNames()
Returns a list of all unique field names that exist in the index pointed to by this IndexReader. |
Collection |
getFieldNames(boolean indexed)
Returns a list of all unique field names that exist in the index pointed to by this IndexReader. |
boolean |
hasDeletions()
Returns true if any documents have been deleted |
boolean |
isDeleted(int n)
Returns true if document n has been deleted |
int |
maxDoc()
Returns one greater than the largest possible document number. |
byte[] |
norms(String f)
Returns the byte-encoded normalization factor for the named field of every document. |
int |
numDocs()
Returns the number of documents in this index. |
void |
setNorm(int d,
String f,
byte b)
Expert: Resets the normalization factor for the named field of the named document. |
TermDocs |
termDocs()
Returns an unpositioned FilterIndexReader.FilterTermDocs enumerator. |
TermPositions |
termPositions()
Returns an unpositioned TermPositions enumerator. |
TermEnum |
terms()
Returns an enumeration of all the terms in the index. |
TermEnum |
terms(Term t)
Returns an enumeration of all terms after a given term. |
void |
undeleteAll()
Undeletes all documents currently marked as deleted in this index. |
Methods inherited from class org.apache.lucene.index.IndexReader |
close, delete, delete, directory, finalize, getCurrentVersion, getCurrentVersion, getCurrentVersion, indexExists, indexExists, indexExists, isLocked, isLocked, lastModified, lastModified, lastModified, open, open, open, setNorm, termDocs, termPositions, unlock |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected IndexReader in
Constructor Detail |
public FilterIndexReader(IndexReader in)
Method Detail |
public int numDocs()
IndexReader
numDocs
in class IndexReader
public int maxDoc()
IndexReader
maxDoc
in class IndexReader
public Document document(int n) throws IOException
IndexReader
n
th
Document
in this index.
document
in class IndexReader
IOException
public boolean isDeleted(int n)
IndexReader
isDeleted
in class IndexReader
public boolean hasDeletions()
IndexReader
hasDeletions
in class IndexReader
public void undeleteAll() throws IOException
IndexReader
undeleteAll
in class IndexReader
IOException
public byte[] norms(String f) throws IOException
IndexReader
norms
in class IndexReader
IOException
Field.setBoost(float)
public void setNorm(int d, String f, byte b) throws IOException
IndexReader
boost
and its length normalization
. Thus, to preserve the length normalization
values when resetting this, one should base the new value upon the old.
setNorm
in class IndexReader
IOException
IndexReader.norms(String)
,
Similarity.decodeNorm(byte)
public TermEnum terms() throws IOException
IndexReader
terms
in class IndexReader
IOException
public TermEnum terms(Term t) throws IOException
IndexReader
terms
in class IndexReader
IOException
public int docFreq(Term t) throws IOException
IndexReader
t
.
docFreq
in class IndexReader
IOException
public TermDocs termDocs() throws IOException
IndexReader
TermDocs
enumerator.
termDocs
in class IndexReader
IOException
public TermPositions termPositions() throws IOException
IndexReader
TermPositions
enumerator.
termPositions
in class IndexReader
IOException
protected void doDelete(int n) throws IOException
IndexReader
docNum
.
Applications should call IndexReader.delete(int)
or IndexReader.delete(Term)
.
doDelete
in class IndexReader
IOException
protected void doClose() throws IOException
IndexReader
doClose
in class IndexReader
IOException
public Collection getFieldNames() throws IOException
IndexReader
getFieldNames
in class IndexReader
IOException
- if there is a problem with accessing the indexpublic Collection getFieldNames(boolean indexed) throws IOException
IndexReader
getFieldNames
in class IndexReader
indexed
- true
if only indexed fields should be returned;
false
if only unindexed fields should be returned.
IOException
- if there is a problem with accessing the index
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |