|
|||||||||||
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. |
Nested classes inherited from class org.apache.lucene.index.IndexReader |
IndexReader.FieldOption |
Field Summary | |
protected IndexReader |
in
|
Fields inherited from class org.apache.lucene.index.IndexReader |
deleter |
Constructor Summary | |
FilterIndexReader(IndexReader in)
Construct a FilterIndexReader based on the specified base reader. |
Method Summary | |
int |
docFreq(Term t)
Returns the number of documents containing the term t . |
protected void |
doClose()
Implements close. |
protected void |
doCommit()
Implements commit. |
Document |
document(int n,
FieldSelector fieldSelector)
Get the Document at the n th position. |
protected void |
doDelete(int n)
Implements deletion of the document numbered docNum . |
protected void |
doSetNorm(int d,
String f,
byte b)
Implements setNorm in subclass. |
protected void |
doUndeleteAll()
Implements actual undeleteAll() in subclass. |
Collection |
getFieldNames(IndexReader.FieldOption fieldNames)
Get a list of unique field names that exist in this index and have the specified field option information. |
TermFreqVector |
getTermFreqVector(int docNumber,
String field)
Return a term frequency vector for the specified document and field. |
TermFreqVector[] |
getTermFreqVectors(int docNumber)
Return an array of term frequency vectors for the specified document. |
long |
getVersion()
Version number when this IndexReader was opened. |
boolean |
hasDeletions()
Returns true if any documents have been deleted |
boolean |
hasNorms(String field)
Returns true if there are norms stored for this field. |
boolean |
isCurrent()
Check whether this IndexReader still works on a current version of the index. |
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. |
void |
norms(String f,
byte[] bytes,
int offset)
Reads the byte-encoded normalization factor for the named field of every document. |
int |
numDocs()
Returns the number of documents in this index. |
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. |
Methods inherited from class org.apache.lucene.index.IndexReader |
close, commit, deleteDocument, deleteDocuments, directory, document, finalize, getCurrentVersion, getCurrentVersion, getCurrentVersion, getDeleter, indexExists, indexExists, indexExists, isLocked, isLocked, isOptimized, lastModified, lastModified, lastModified, main, open, open, open, setDeleter, setNorm, setNorm, termDocs, termPositions, undeleteAll, 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)
Construct a FilterIndexReader based on the specified base reader. Directory locking for delete, undeleteAll, and setNorm operations is left to the base reader.
Note that base reader is closed if this FilterIndexReader is closed.
in
- specified base reader.Method Detail |
public TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException
IndexReader
getTermFreqVectors
in class IndexReader
docNumber
- document for which term frequency vectors are returned
IOException
- if index cannot be accessedField.TermVector
public TermFreqVector getTermFreqVector(int docNumber, String field) throws IOException
IndexReader
getTermFreqVector
in class IndexReader
docNumber
- document for which the term frequency vector is returnedfield
- field for which the term frequency vector is returned.
IOException
- if index cannot be accessedField.TermVector
public int numDocs()
IndexReader
numDocs
in class IndexReader
public int maxDoc()
IndexReader
maxDoc
in class IndexReader
public Document document(int n, FieldSelector fieldSelector) throws IOException
IndexReader
Document
at the n
th position. The FieldSelector
may be used to determine what Field
s to load and how they should be loaded.
NOTE: If this Reader (more specifically, the underlying FieldsReader
is closed before the lazy Field
is
loaded an exception may be thrown. If you want the value of a lazy Field
to be available after closing you must
explicitly load it or fetch the Document again with a new loader.
document
in class IndexReader
n
- Get the document at the n
th positionfieldSelector
- The FieldSelector
to use to determine what Fields should be loaded on the Document. May be null, in which case all Fields will be loaded.
Document
at the nth position
IOException
- If there is a problem reading this documentFieldable
,
FieldSelector
,
SetBasedFieldSelector
,
LoadFirstFieldSelector
public boolean isDeleted(int n)
IndexReader
isDeleted
in class IndexReader
public boolean hasDeletions()
IndexReader
hasDeletions
in class IndexReader
protected void doUndeleteAll() throws IOException
IndexReader
doUndeleteAll
in class IndexReader
IOException
public boolean hasNorms(String field) throws IOException
IndexReader
hasNorms
in class IndexReader
IOException
public byte[] norms(String f) throws IOException
IndexReader
norms
in class IndexReader
IOException
AbstractField.setBoost(float)
public void norms(String f, byte[] bytes, int offset) throws IOException
IndexReader
norms
in class IndexReader
IOException
AbstractField.setBoost(float)
protected void doSetNorm(int d, String f, byte b) throws IOException
IndexReader
doSetNorm
in class IndexReader
IOException
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.deleteDocument(int)
or IndexReader.deleteDocuments(Term)
.
doDelete
in class IndexReader
IOException
protected void doCommit() throws IOException
IndexReader
doCommit
in class IndexReader
IOException
protected void doClose() throws IOException
IndexReader
doClose
in class IndexReader
IOException
public Collection getFieldNames(IndexReader.FieldOption fieldNames)
IndexReader
getFieldNames
in class IndexReader
fieldNames
- specifies which field option should be available for the returned fields
IndexReader.FieldOption
public long getVersion()
IndexReader
getVersion
in class IndexReader
public boolean isCurrent() throws IOException
IndexReader
isCurrent
in class IndexReader
IOException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |