Package org.elasticsearch.index.fieldvisitor

Class FieldsVisitor

java.lang.Object

org.apache.lucene.index.StoredFieldVisitor

org.elasticsearch.index.fieldvisitor.FieldsVisitor

Direct Known Subclasses:

CustomFieldsVisitor

public class FieldsVisitor
extends StoredFieldVisitor

Base StoredFieldVisitor that retrieves all non-redundant metadata.

Nested Class Summary

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

StoredFieldVisitor.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<Object>>	fieldsValues
protected String	id
protected BytesReference	source
protected String	type

Constructor Summary

Constructors

Constructor	Description
FieldsVisitor(boolean loadSource)
FieldsVisitor(boolean loadSource, String sourceFieldName)

Method Summary

Modifier and Type	Method	Description
void	binaryField(FieldInfo fieldInfo, byte[] value)	Process a binary field.
void	doubleField(FieldInfo fieldInfo, double value)	Process a double numeric field.
Map<String,List<Object>>	fields()
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.
StoredFieldVisitor.Status	needsField(FieldInfo fieldInfo)	Hook before processing a field.
void	postProcess(MapperService mapperService)
void	reset()
String	routing()
BytesReference	source()
void	stringField(FieldInfo fieldInfo, byte[] bytes)	Process a string field; the provided byte[] value is a UTF-8 encoded string value.
Uid	uid()

Methods inherited from class java.lang.Object

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

Field Detail

source

protected BytesReference source

type

protected String type

id

protected String id

fieldsValues

protected Map<String,List<Object>> fieldsValues

Constructor Detail

FieldsVisitor

public FieldsVisitor(boolean loadSource)

FieldsVisitor

public FieldsVisitor(boolean loadSource,
                     String sourceFieldName)

Method Detail

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

postProcess

public void postProcess(MapperService mapperService)

binaryField

public void binaryField(FieldInfo fieldInfo,
                        byte[] value)
                 throws IOException

Description copied from class: StoredFieldVisitor

Process a binary field.

Overrides:

binaryField in class StoredFieldVisitor

value - newly allocated byte array with the binary contents.

Throws:

IOException

stringField

public void stringField(FieldInfo fieldInfo,
                        byte[] bytes)
                 throws IOException

Description copied from class: StoredFieldVisitor

Process a string field; the provided byte[] value is a UTF-8 encoded string value.

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

source

public BytesReference source()

uid

public Uid uid()

routing

public String routing()

fields

public Map<String,List<Object>> fields()

reset

public void reset()