Package org.elasticsearch.index.fieldvisitor

Class CustomFieldsVisitor

java.lang.Object

org.apache.lucene.index.StoredFieldVisitor

org.elasticsearch.index.fieldvisitor.FieldsVisitor

org.elasticsearch.index.fieldvisitor.CustomFieldsVisitor

public class CustomFieldsVisitor
extends FieldsVisitor

A field visitor that allows to load a selection of the stored fields by exact name or by pattern. Supported pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy". The Uid field is always loaded. The class is optimized for source loading as it is a common use case.

Nested Class Summary

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

org.apache.lucene.index.StoredFieldVisitor.Status

Field Summary

Fields inherited from class org.elasticsearch.index.fieldvisitor.FieldsVisitor

fieldsValues, id, source, type

Constructor Summary

Constructors

Constructor	Description
CustomFieldsVisitor(java.util.Set<java.lang.String> fields, boolean loadSource)
CustomFieldsVisitor(java.util.Set<java.lang.String> fields, java.util.List<java.lang.String> patterns, boolean loadSource)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.index.StoredFieldVisitor.Status	needsField(org.apache.lucene.index.FieldInfo fieldInfo)

Methods inherited from class org.elasticsearch.index.fieldvisitor.FieldsVisitor

binaryField, doubleField, fields, floatField, intField, longField, postProcess, reset, routing, source, stringField, uid

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldsVisitor

public CustomFieldsVisitor(java.util.Set<java.lang.String> fields,
                           java.util.List<java.lang.String> patterns,
                           boolean loadSource)

CustomFieldsVisitor

public CustomFieldsVisitor(java.util.Set<java.lang.String> fields,
                           boolean loadSource)

Method Detail

needsField

public org.apache.lucene.index.StoredFieldVisitor.Status needsField(org.apache.lucene.index.FieldInfo fieldInfo)
                                                             throws java.io.IOException

Overrides:

needsField in class FieldsVisitor

Throws:

java.io.IOException