Module org.apache.lucene.highlighter

Package org.apache.lucene.search.matchhighlight

Class MatchRegionRetriever.StoredFieldsVisitor

java.lang.Object

org.apache.lucene.index.StoredFieldVisitor

org.apache.lucene.search.matchhighlight.MatchRegionRetriever.StoredFieldsVisitor

All Implemented Interfaces:

Iterable<String>, MatchRegionRetriever.FieldValueProvider

Enclosing class:

MatchRegionRetriever

private static class MatchRegionRetriever.StoredFieldsVisitor
extends StoredFieldVisitor
implements MatchRegionRetriever.FieldValueProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.StoredFieldVisitor

StoredFieldVisitor.Status

Field Summary

Fields

Modifier and Type	Field	Description
private final LinkedHashMap<String,List<String>>	fieldValues
private final Predicate<String>	needsField

Constructor Summary

Constructors

Constructor	Description
StoredFieldsVisitor(Predicate<String> shouldLoadStoredField)

Method Summary

Modifier and Type	Method	Description
private void	addField(FieldInfo field, String value)
void	doubleField(FieldInfo fieldInfo, double value)	Process a double numeric field.
void	floatField(FieldInfo fieldInfo, float value)	Process a float numeric field.
List<String>	getValues(String field)
void	intField(FieldInfo fieldInfo, int value)	Process a int numeric field.
Iterator<String>	iterator()
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 org.apache.lucene.index.StoredFieldVisitor

binaryField, binaryField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

needsField

private final Predicate<String> needsField

fieldValues

private final LinkedHashMap<String,List<String>> fieldValues

Constructor Details

StoredFieldsVisitor

public StoredFieldsVisitor(Predicate<String> shouldLoadStoredField)

Method Details

needsField

public StoredFieldVisitor.Status needsField(FieldInfo fieldInfo)
                                     throws IOException

Description copied from class: StoredFieldVisitor

Hook before processing a field. Before a field is processed, this method is invoked so that subclasses can return a StoredFieldVisitor.Status representing whether they need that particular field or not, or to stop processing entirely.

Specified by:

needsField in class StoredFieldVisitor

Throws:

IOException

getValues

public List<String> getValues(String field)

Specified by:

getValues in interface MatchRegionRetriever.FieldValueProvider

Returns:

Return a list of values for the provided field name or null if the field is not loaded or does not exist for the field.

stringField

public void stringField(FieldInfo fieldInfo,
 String value)
                 throws IOException

Description copied from class: StoredFieldVisitor

Process a string field.

Overrides:

stringField in class StoredFieldVisitor

Throws:

IOException

intField

public void intField(FieldInfo fieldInfo,
 int value)
              throws IOException

Description copied from class: StoredFieldVisitor

Process a int numeric field.

Overrides:

intField in class StoredFieldVisitor

Throws:

IOException

longField

public void longField(FieldInfo fieldInfo,
 long value)
               throws IOException

Description copied from class: StoredFieldVisitor

Process a long numeric field.

Overrides:

longField in class StoredFieldVisitor

Throws:

IOException

floatField

public void floatField(FieldInfo fieldInfo,
 float value)
                throws IOException

Description copied from class: StoredFieldVisitor

Process a float numeric field.

Overrides:

floatField in class StoredFieldVisitor

Throws:

IOException

doubleField

public void doubleField(FieldInfo fieldInfo,
 double value)
                 throws IOException

Description copied from class: StoredFieldVisitor

Process a double numeric field.

Overrides:

doubleField in class StoredFieldVisitor

Throws:

IOException

addField

private void addField(FieldInfo field,
 String value)

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>