|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.index.StoredFieldVisitor org.apache.lucene.document.DocumentStoredFieldVisitor
public class DocumentStoredFieldVisitor
A StoredFieldVisitor
that creates a Document
containing all stored fields, or only specific
requested fields provided to DocumentStoredFieldVisitor(Set)
.
This is used by IndexReader.document(int)
to load a
document.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.index.StoredFieldVisitor |
---|
StoredFieldVisitor.Status |
Constructor Summary | |
---|---|
DocumentStoredFieldVisitor()
Load all stored fields. |
|
DocumentStoredFieldVisitor(Set<String> fieldsToAdd)
Load only fields named in the provided Set<String> . |
|
DocumentStoredFieldVisitor(String... fields)
Load only fields named in the provided fields. |
Method Summary | |
---|---|
void |
binaryField(FieldInfo fieldInfo,
byte[] value)
Process a binary field. |
void |
doubleField(FieldInfo fieldInfo,
double value)
Process a double numeric field. |
void |
floatField(FieldInfo fieldInfo,
float value)
Process a float numeric field. |
Document |
getDocument()
Retrieve the visited document. |
void |
intField(FieldInfo fieldInfo,
int value)
Process a int numeric field. |
void |
longField(FieldInfo fieldInfo,
long value)
Process a long numeric field. |
StoredFieldVisitor.Status |
needsField(FieldInfo fieldInfo)
Hook before processing a field. |
void |
stringField(FieldInfo fieldInfo,
String value)
Process a string field |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocumentStoredFieldVisitor(Set<String> fieldsToAdd)
Set<String>
.
fieldsToAdd
- Set of fields to load, or null
(all fields).public DocumentStoredFieldVisitor(String... fields)
public DocumentStoredFieldVisitor()
Method Detail |
---|
public void binaryField(FieldInfo fieldInfo, byte[] value) throws IOException
StoredFieldVisitor
binaryField
in class StoredFieldVisitor
value
- newly allocated byte array with the binary contents.
IOException
public void stringField(FieldInfo fieldInfo, String value) throws IOException
StoredFieldVisitor
stringField
in class StoredFieldVisitor
IOException
public void intField(FieldInfo fieldInfo, int value)
StoredFieldVisitor
intField
in class StoredFieldVisitor
public void longField(FieldInfo fieldInfo, long value)
StoredFieldVisitor
longField
in class StoredFieldVisitor
public void floatField(FieldInfo fieldInfo, float value)
StoredFieldVisitor
floatField
in class StoredFieldVisitor
public void doubleField(FieldInfo fieldInfo, double value)
StoredFieldVisitor
doubleField
in class StoredFieldVisitor
public StoredFieldVisitor.Status needsField(FieldInfo fieldInfo) throws IOException
StoredFieldVisitor
StoredFieldVisitor.Status
representing whether
they need that particular field or not, or to stop processing
entirely.
needsField
in class StoredFieldVisitor
IOException
public Document getDocument()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |