Package org.apache.lucene.index
Class StoredFields
- java.lang.Object
-
- org.apache.lucene.index.StoredFields
-
- Direct Known Subclasses:
StoredFieldsReader
public abstract class StoredFields extends Object
API for reading stored fields.NOTE: This class is not thread-safe and should only be consumed in the thread where it was acquired.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedStoredFields()Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Documentdocument(int docID)Returns the stored fields of thenthDocumentin this index.Documentdocument(int docID, Set<String> fieldsToLoad)Likedocument(int)but only loads the specified fields.abstract voiddocument(int docID, StoredFieldVisitor visitor)Expert: visits the fields of a stored document, for custom processing/loading of each field.
-
-
-
Method Detail
-
document
public final Document document(int docID) throws IOException
Returns the stored fields of thenthDocumentin this index. This is just sugar for usingDocumentStoredFieldVisitor.NOTE: for performance reasons, this method does not check if the requested document is deleted, and therefore asking for a deleted document may yield unspecified results. Usually this is not required, however you can test if the doc is deleted by checking the
Bitsreturned fromMultiBits.getLiveDocs(org.apache.lucene.index.IndexReader).NOTE: only the content of a field is returned, if that field was stored during indexing. Metadata like boost, omitNorm, IndexOptions, tokenized, etc., are not preserved.
- Throws:
CorruptIndexException- if the index is corruptIOException- if there is a low-level IO error
-
document
public abstract void document(int docID, StoredFieldVisitor visitor) throws IOExceptionExpert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, usedocument(int). If you want to load a subset, useDocumentStoredFieldVisitor.- Throws:
IOException
-
document
public final Document document(int docID, Set<String> fieldsToLoad) throws IOException
Likedocument(int)but only loads the specified fields. Note that this is simply sugar forDocumentStoredFieldVisitor(Set).- Throws:
IOException
-
-