Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.lucene.index.IndexReader
public abstract class IndexReader
extends Object
open()
methods, e.g. open(String)
.
For efficiency, in this API documents are often referred to via
document numbers, non-negative integers which each name a unique
document in the index. These document numbers are ephemeral--they may change
as documents are added to and deleted from an index. Clients should thus not
rely on a given document having the same number between sessions.
An IndexReader can be opened on a directory for which an IndexWriter is
opened already, but it cannot be used to delete documents from the index then.
Nested Class Summary | |
static class |
Constructor Summary | |
|
Method Summary | |
void |
|
protected void |
|
void |
|
int | |
void |
|
int |
|
Directory |
|
protected abstract void |
|
protected abstract void |
|
protected abstract void |
|
protected abstract void |
|
protected abstract void |
|
abstract int | |
abstract Document |
|
protected void |
|
static long |
|
static long |
|
static long |
|
abstract Collection |
|
abstract Collection |
|
abstract Collection |
|
Collection |
|
abstract Collection |
|
abstract TermFreqVector |
|
abstract TermFreqVector[] |
|
long |
|
abstract boolean |
|
boolean |
|
static boolean |
|
static boolean |
|
static boolean |
|
boolean |
|
abstract boolean |
|
static boolean |
|
static boolean | |
static long |
|
static long |
|
static long |
|
static void |
|
abstract int |
|
abstract byte[] |
|
abstract void |
|
abstract int |
|
static IndexReader |
|
static IndexReader |
|
static IndexReader | |
void |
|
void |
|
abstract TermDocs | |
TermDocs | |
abstract TermPositions |
|
TermPositions |
|
abstract TermEnum |
|
abstract TermEnum | |
void |
|
static void |
protected IndexReader(Directory directory)
Constructor used if IndexReader is not owner of its directory. This is used for IndexReaders that are used within other IndexReaders that take care or locking directories.
- Parameters:
directory
- Directory where IndexReader files reside.
public final void close() throws IOException
Closes files associated with this index. Also saves any new deletions to disk. No other methods should be called after this has been called.
protected final void commit() throws IOException
Commit changes resulting from delete, undeleteAll, or setNorm operations
public final void delete(int docNum) throws IOException
Deprecated. Use
deleteDocument(int docNum)
instead.Deletes the document numbereddocNum
. Once a document is deleted it will not appear in TermDocs or TermPostitions enumerations. Attempts to read its field with thedocument(int)
method will result in an error. The presence of this document may still be reflected in thedocFreq(Term)
statistic, though this will be corrected eventually as the index is further modified.
public final int delete(Term term) throws IOException
Deprecated. Use
deleteDocuments(Term term)
instead.Deletes all documents containingterm
. This is useful if one uses a document field to hold a unique ID string for the document. Then to delete such a document, one merely constructs a term with the appropriate field and the unique ID string as its text and passes it to this method. Seedelete(int)
for information about when this deletion will become effective.
- Returns:
- the number of documents deleted
public final void deleteDocument(int docNum) throws IOException
Deletes the document numbereddocNum
. Once a document is deleted it will not appear in TermDocs or TermPostitions enumerations. Attempts to read its field with thedocument(int)
method will result in an error. The presence of this document may still be reflected in thedocFreq(Term)
statistic, though this will be corrected eventually as the index is further modified.
public final int deleteDocuments(Term term) throws IOException
Deletes all documents containingterm
. This is useful if one uses a document field to hold a unique ID string for the document. Then to delete such a document, one merely constructs a term with the appropriate field and the unique ID string as its text and passes it to this method. Seedelete(int)
for information about when this deletion will become effective.
- Returns:
- the number of documents deleted
protected abstract void doClose() throws IOException
Implements close.
protected abstract void doCommit() throws IOException
Implements commit.
protected abstract void doDelete(int docNum) throws IOException
Implements deletion of the document numbereddocNum
. Applications should calldelete(int)
ordelete(Term)
.
protected abstract void doSetNorm(int doc, String field, byte value) throws IOException
Implements setNorm in subclass.
protected abstract void doUndeleteAll() throws IOException
Implements actual undeleteAll() in subclass.
public abstract int docFreq(Term t) throws IOException
Returns the number of documents containing the termt
.
public abstract Document document(int n) throws IOException
Returns the stored fields of then
thDocument
in this index.
protected void finalize()
Release the write lock, if needed.
public static long getCurrentVersion(File directory) throws IOException
Reads version number from segments files. The version number is initialized with a timestamp and then increased by one for each change of the index.
- Parameters:
directory
- where the index resides.
- Returns:
- version number.
public static long getCurrentVersion(String directory) throws IOException
Reads version number from segments files. The version number is initialized with a timestamp and then increased by one for each change of the index.
- Parameters:
directory
- where the index resides.
- Returns:
- version number.
public static long getCurrentVersion(Directory directory) throws IOException
Reads version number from segments files. The version number is initialized with a timestamp and then increased by one for each change of the index.
- Parameters:
directory
- where the index resides.
- Returns:
- version number.
public abstract Collection getFieldNames() throws IOException
Deprecated. Replaced by
getFieldNames(IndexReader.FieldOption)
Returns a list of all unique field names that exist in the index pointed to by this IndexReader.
- Returns:
- Collection of Strings indicating the names of the fields
public abstract Collection getFieldNames(boolean indexed) throws IOException
Deprecated. Replaced by
getFieldNames(IndexReader.FieldOption)
Returns a list of all unique field names that exist in the index pointed to by this IndexReader. The boolean argument specifies whether the fields returned are indexed or not.
- Parameters:
indexed
-true
if only indexed fields should be returned;false
if only unindexed fields should be returned.
- Returns:
- Collection of Strings indicating the names of the fields
public abstract Collection getFieldNames(IndexReader.FieldOption fldOption)
Get a list of unique field names that exist in this index and have the specified field option information.
- Parameters:
fldOption
- specifies which field option should be available for the returned fields
- Returns:
- Collection of Strings indicating the names of the fields.
- See Also:
IndexReader.FieldOption
public Collection getIndexedFieldNames(boolean storedTermVector)
Deprecated. Replaced by
getFieldNames(IndexReader.FieldOption)
- Parameters:
storedTermVector
- if true, returns only Indexed fields that have term vector info, else only indexed fields without term vector info
- Returns:
- Collection of Strings indicating the names of the fields
public abstract Collection getIndexedFieldNames(Field.TermVector tvSpec)
Deprecated. Replaced by
getFieldNames(IndexReader.FieldOption)
Get a list of unique field names that exist in this index, are indexed, and have the specified term vector information.
- Parameters:
tvSpec
- specifies which term vector information should be available for the fields
- Returns:
- Collection of Strings indicating the names of the fields
public abstract TermFreqVector getTermFreqVector(int docNumber, String field) throws IOException
Return a term frequency vector for the specified document and field. The returned vector contains terms and frequencies for the terms in the specified field of this document, if the field had the storeTermVector flag set. If termvectors had been stored with positions or offsets, a TermPositionsVector is returned.
- Parameters:
docNumber
- document for which the term frequency vector is returnedfield
- field for which the term frequency vector is returned.
- Returns:
- term frequency vector May be null if field does not exist in the specified document or term vector was not stored.
- See Also:
Field.TermVector
public abstract TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException
Return an array of term frequency vectors for the specified document. The array contains a vector for each vectorized field in the document. Each vector contains terms and frequencies for all terms in a given vectorized field. If no such fields existed, the method returns null. The term vectors that are returned my either be of type TermFreqVector or of type TermPositionsVector if positions or offsets have been stored.
- Parameters:
docNumber
- document for which term frequency vectors are returned
- Returns:
- array of term frequency vectors. May be null if no term vectors have been stored for the specified document.
- See Also:
Field.TermVector
public long getVersion()
Version number when this IndexReader was opened.
public abstract boolean hasDeletions()
Returns true if any documents have been deleted
public boolean hasNorms(String field) throws IOException
Returns true if there are norms stored for this field.
public static boolean indexExists(File directory)
Returnstrue
if an index exists at the specified directory. If the directory does not exist or if there is no index in it.
- Parameters:
directory
- the directory to check for an index
- Returns:
true
if an index exists;false
otherwise
public static boolean indexExists(String directory)
Returnstrue
if an index exists at the specified directory. If the directory does not exist or if there is no index in it.false
is returned.
- Parameters:
directory
- the directory to check for an index
- Returns:
true
if an index exists;false
otherwise
public static boolean indexExists(Directory directory) throws IOException
Returnstrue
if an index exists at the specified directory. If the directory does not exist or if there is no index in it.
- Parameters:
directory
- the directory to check for an index
- Returns:
true
if an index exists;false
otherwise
public boolean isCurrent() throws IOException
Check whether this IndexReader still works on a current version of the index. If this is not the case you will need to re-open the IndexReader to make sure you see the latest changes made to the index.
public abstract boolean isDeleted(int n)
Returns true if document n has been deleted
public static boolean isLocked(String directory) throws IOException
Returnstrue
iff the index in the named directory is currently locked.
- Parameters:
directory
- the directory to check for a lock
public static boolean isLocked(Directory directory) throws IOException
Returnstrue
iff the index in the named directory is currently locked.
- Parameters:
directory
- the directory to check for a lock
public static long lastModified(File directory) throws IOException
Returns the time the index in the named directory was last modified. Do not use this to check whether the reader is still up-to-date, useisCurrent()
instead.
public static long lastModified(String directory) throws IOException
Returns the time the index in the named directory was last modified. Do not use this to check whether the reader is still up-to-date, useisCurrent()
instead.
public static long lastModified(Directory directory) throws IOException
Returns the time the index in the named directory was last modified. Do not use this to check whether the reader is still up-to-date, useisCurrent()
instead.
public static void main(String[] args)
Prints the filename and size of each file within a given compound file. Add the -extract flag to extract files to the current working directory. In order to make the extracted version of the index work, you have to copy the segments file from the compound index into the directory where the extracted files are stored.
- Parameters:
args
- Usage: org.apache.lucene.index.IndexReader [-extract] <cfsfile>
public abstract int maxDoc()
Returns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.
public abstract byte[] norms(String field) throws IOException
Returns the byte-encoded normalization factor for the named field of every document. This is used by the search code to score documents.
- See Also:
Field.setBoost(float)
public abstract void norms(String field, byte[] bytes, int offset) throws IOException
Reads the byte-encoded normalization factor for the named field of every document. This is used by the search code to score documents.
- See Also:
Field.setBoost(float)
public abstract int numDocs()
Returns the number of documents in this index.
public static IndexReader open(File path) throws IOException
Returns an IndexReader reading the index in an FSDirectory in the named path.
public static IndexReader open(String path) throws IOException
Returns an IndexReader reading the index in an FSDirectory in the named path.
public static IndexReader open(Directory directory) throws IOException
Returns an IndexReader reading the index in the given Directory.
public final void setNorm(int doc, String field, byte value) throws IOException
Expert: Resets the normalization factor for the named field of the named document. The norm represents the product of the field'sboost
and itslength normalization
. Thus, to preserve the length normalization values when resetting this, one should base the new value upon the old.
- See Also:
norms(String)
,Similarity.decodeNorm(byte)
public void setNorm(int doc, String field, float value) throws IOException
Expert: Resets the normalization factor for the named field of the named document.
- See Also:
norms(String)
,Similarity.decodeNorm(byte)
public abstract TermDocs termDocs() throws IOException
Returns an unpositionedTermDocs
enumerator.
public TermDocs termDocs(Term term) throws IOException
Returns an enumeration of all the documents which containterm
. For each document, the document number, the frequency of the term in that document is also provided, for use in search scoring. Thus, this method implements the mapping:*
The enumeration is ordered by document number. Each document number is greater than all that precede it in the enumeration.
public abstract TermPositions termPositions() throws IOException
Returns an unpositionedTermPositions
enumerator.
public TermPositions termPositions(Term term) throws IOException
Returns an enumeration of all the documents which containterm
. For each document, in addition to the document number and frequency of the term in that document, a list of all of the ordinal positions of the term in the document is available. Thus, this method implements the mapping:12freq-1*
This positional information faciliates phrase and proximity searching. The enumeration is ordered by document number. Each document number is greater than all that precede it in the enumeration.
public abstract TermEnum terms() throws IOException
Returns an enumeration of all the terms in the index. The enumeration is ordered by Term.compareTo(). Each term is greater than all that precede it in the enumeration.
public abstract TermEnum terms(Term t) throws IOException
Returns an enumeration of all terms after a given term. The enumeration is ordered by Term.compareTo(). Each term is greater than all that precede it in the enumeration.
public final void undeleteAll() throws IOException
Undeletes all documents currently marked as deleted in this index.
public static void unlock(Directory directory) throws IOException
Forcibly unlocks the index in the named directory. Caution: this should only be used by failure recovery code, when it is known that no other process nor thread is in fact currently accessing this index.