|
||||||||||
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
public class 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/interfaces inherited from class org.apache.lucene.index.IndexReader |
---|
IndexReader.FieldOption |
Field Summary | |
---|---|
protected IndexReader |
in
|
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)
Returns the stored fields of the n th
Document in this index. |
protected void |
doDelete(int n)
Implements deletion of the document numbered docNum . |
protected void |
doSetNorm(int d,
java.lang.String f,
byte b)
Implements setNorm in subclass. |
protected void |
doUndeleteAll()
Implements actual undeleteAll() in subclass. |
java.util.Collection |
getFieldNames()
Returns a list of all unique field names that exist in the index pointed to by this IndexReader. |
java.util.Collection |
getFieldNames(boolean indexed)
Returns a list of all unique field names that exist in the index pointed to by this IndexReader. |
java.util.Collection |
getFieldNames(IndexReader.FieldOption fieldNames)
Get a list of unique field names that exist in this index and have the specified field option information. |
java.util.Collection |
getIndexedFieldNames(Field.TermVector tvSpec)
Get a list of unique field names that exist in this index, are indexed, and have the specified term vector information. |
TermFreqVector |
getTermFreqVector(int docNumber,
java.lang.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. |
boolean |
hasDeletions()
Returns true if any documents have been deleted |
boolean |
hasNorms(java.lang.String field)
Returns true if there are norms stored for this field. |
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(java.lang.String f)
Returns the byte-encoded normalization factor for the named field of every document. |
void |
norms(java.lang.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 TermDocs 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, delete, delete, deleteDocument, deleteDocuments, directory, finalize, getCurrentVersion, getCurrentVersion, getCurrentVersion, getIndexedFieldNames, getVersion, indexExists, indexExists, indexExists, isCurrent, isLocked, isLocked, lastModified, lastModified, lastModified, main, open, open, open, 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 java.io.IOException
IndexReader
getTermFreqVectors
in class IndexReader
docNumber
- document for which term frequency vectors are returned
java.io.IOException
- if index cannot be accessedField.TermVector
public TermFreqVector getTermFreqVector(int docNumber, java.lang.String field) throws java.io.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.
java.io.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) throws java.io.IOException
IndexReader
n
th
Document
in this index.
document
in class IndexReader
java.io.IOException
public boolean isDeleted(int n)
IndexReader
isDeleted
in class IndexReader
public boolean hasDeletions()
IndexReader
hasDeletions
in class IndexReader
protected void doUndeleteAll() throws java.io.IOException
IndexReader
doUndeleteAll
in class IndexReader
java.io.IOException
public boolean hasNorms(java.lang.String field) throws java.io.IOException
IndexReader
hasNorms
in class IndexReader
java.io.IOException
public byte[] norms(java.lang.String f) throws java.io.IOException
IndexReader
norms
in class IndexReader
java.io.IOException
Field.setBoost(float)
public void norms(java.lang.String f, byte[] bytes, int offset) throws java.io.IOException
IndexReader
norms
in class IndexReader
java.io.IOException
Field.setBoost(float)
protected void doSetNorm(int d, java.lang.String f, byte b) throws java.io.IOException
IndexReader
doSetNorm
in class IndexReader
java.io.IOException
public TermEnum terms() throws java.io.IOException
IndexReader
terms
in class IndexReader
java.io.IOException
public TermEnum terms(Term t) throws java.io.IOException
IndexReader
terms
in class IndexReader
java.io.IOException
public int docFreq(Term t) throws java.io.IOException
IndexReader
t
.
docFreq
in class IndexReader
java.io.IOException
public TermDocs termDocs() throws java.io.IOException
IndexReader
TermDocs
enumerator.
termDocs
in class IndexReader
java.io.IOException
public TermPositions termPositions() throws java.io.IOException
IndexReader
TermPositions
enumerator.
termPositions
in class IndexReader
java.io.IOException
protected void doDelete(int n) throws java.io.IOException
IndexReader
docNum
.
Applications should call IndexReader.delete(int)
or IndexReader.delete(Term)
.
doDelete
in class IndexReader
java.io.IOException
protected void doCommit() throws java.io.IOException
IndexReader
doCommit
in class IndexReader
java.io.IOException
protected void doClose() throws java.io.IOException
IndexReader
doClose
in class IndexReader
java.io.IOException
public java.util.Collection getFieldNames() throws java.io.IOException
IndexReader
getFieldNames
in class IndexReader
java.io.IOException
- if there is a problem with accessing the indexpublic java.util.Collection getFieldNames(boolean indexed) throws java.io.IOException
IndexReader
getFieldNames
in class IndexReader
indexed
- true
if only indexed fields should be returned;
false
if only unindexed fields should be returned.
java.io.IOException
- if there is a problem with accessing the indexpublic java.util.Collection getIndexedFieldNames(Field.TermVector tvSpec)
IndexReader
getIndexedFieldNames
in class IndexReader
tvSpec
- specifies which term vector information should be available for the fields
public java.util.Collection getFieldNames(IndexReader.FieldOption fieldNames)
IndexReader
getFieldNames
in class IndexReader
fieldNames
- specifies which field option should be available for the returned fields
IndexReader.FieldOption
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |