public abstract class StoredFieldVisitor extends Object
IndexReader.document(int,
StoredFieldVisitor)
.
NOTE: a StoredFieldVisitor
implementation
should not try to load or visit other stored documents in
the same reader because the implementation of stored
fields for most codecs is not reeentrant and you will see
strange exceptions as a result.
See DocumentStoredFieldVisitor
, which is a
StoredFieldVisitor
that builds the
Document
containing all stored fields. This is
used by IndexReader.document(int)
.
Modifier and Type | Class and Description |
---|---|
static class |
StoredFieldVisitor.Status
Enumeration of possible return values for
needsField(org.apache.lucene.index.FieldInfo) . |
Modifier | Constructor and Description |
---|---|
protected |
StoredFieldVisitor()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
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.
|
void |
intField(FieldInfo fieldInfo,
int value)
Process a int numeric field.
|
void |
longField(FieldInfo fieldInfo,
long value)
Process a long numeric field.
|
abstract StoredFieldVisitor.Status |
needsField(FieldInfo fieldInfo)
Hook before processing a field.
|
void |
stringField(FieldInfo fieldInfo,
byte[] value)
Process a string field; the provided byte[] value is a UTF-8 encoded string value.
|
protected StoredFieldVisitor()
public void binaryField(FieldInfo fieldInfo, byte[] value) throws IOException
value
- newly allocated byte array with the binary contents.IOException
public void stringField(FieldInfo fieldInfo, byte[] value) throws IOException
IOException
public void intField(FieldInfo fieldInfo, int value) throws IOException
IOException
public void longField(FieldInfo fieldInfo, long value) throws IOException
IOException
public void floatField(FieldInfo fieldInfo, float value) throws IOException
IOException
public void doubleField(FieldInfo fieldInfo, double value) throws IOException
IOException
public abstract StoredFieldVisitor.Status needsField(FieldInfo fieldInfo) throws IOException
StoredFieldVisitor.Status
representing whether
they need that particular field or not, or to stop processing
entirely.IOException
Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.