public class FilterIndexReader extends IndexReader
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.Modifier and Type | Class and Description |
---|---|
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. |
Modifier and Type | Field and Description |
---|---|
protected IndexReader |
in |
Constructor and Description |
---|
FilterIndexReader(IndexReader in)
Construct a FilterIndexReader based on the specified base reader.
|
Modifier and Type | Method and Description |
---|---|
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,
String f,
byte b)
Implements setNorm in subclass.
|
protected void |
doUndeleteAll()
Implements actual undeleteAll() in subclass.
|
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.
|
Collection |
getIndexedFieldNames(boolean storedTermVector) |
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.
|
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.
|
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
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.
|
close, commit, delete, delete, directory, finalize, getCurrentVersion, getCurrentVersion, getCurrentVersion, indexExists, indexExists, indexExists, isLocked, isLocked, lastModified, lastModified, lastModified, open, open, open, setNorm, setNorm, termDocs, termPositions, undeleteAll, unlock
protected IndexReader in
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.public TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException
IndexReader
getTermFreqVectors
in class IndexReader
IOException
Field.isTermVectorStored()
public TermFreqVector getTermFreqVector(int docNumber, String field) throws IOException
IndexReader
getTermFreqVector
in class IndexReader
IOException
Field.isTermVectorStored()
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
protected void doUndeleteAll() throws IOException
IndexReader
doUndeleteAll
in class IndexReader
IOException
public byte[] norms(String f) throws IOException
IndexReader
norms
in class IndexReader
IOException
Field.setBoost(float)
public void norms(String f, byte[] bytes, int offset) throws IOException
IndexReader
norms
in class IndexReader
IOException
Field.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.delete(int)
or IndexReader.delete(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() 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 indexpublic Collection getIndexedFieldNames(boolean storedTermVector)
getIndexedFieldNames
in class IndexReader
storedTermVector
- if true, returns only Indexed fields that have term vector info,
else only indexed fields without term vector infoCopyright © 2023 GATE. All rights reserved.