Class StoredFields
- Direct Known Subclasses:
StoredFieldsReader
NOTE: This class is not thread-safe and should only be consumed in the thread where it was acquired.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal Documentdocument(int docID) Returns the stored fields of thenthDocumentin this index.final DocumentLikedocument(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.voidprefetch(int docID) Optional method: Give a hint to thisStoredFieldsinstance that the given document will be read in the near future.
-
Constructor Details
-
StoredFields
protected StoredFields()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
prefetch
Optional method: Give a hint to thisStoredFieldsinstance that the given document will be read in the near future. This typically delegates toIndexInput.prefetch(long, long)and is useful to parallelize I/O across multiple documents.NOTE: This API is expected to be called on a small enough set of doc IDs that they could all fit in the page cache. If you plan on retrieving a very large number of documents, it may be a good idea to perform calls to
prefetch(int)anddocument(int)in batches instead of prefetching all documents up-front.- Throws:
IOException
-
document
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
Expert: 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
Likedocument(int)but only loads the specified fields. Note that this is simply sugar forDocumentStoredFieldVisitor(Set).- Throws:
IOException
-