Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class DocValueFetcher

java.lang.Object

org.elasticsearch.index.mapper.DocValueFetcher

All Implemented Interfaces:

ValueFetcher

public final class DocValueFetcher
extends Object
implements ValueFetcher

Value fetcher that loads from doc values.

Constructor Summary

Constructors

Constructor	Description
DocValueFetcher(DocValueFormat format, IndexFieldData<?> ifd)

Method Summary

Modifier and Type	Method	Description
List<Object>	fetchValues(SourceLookup lookup, List<Object> ignoredValues)	This method is consumed by ValueFetcher.fetchDocumentField(String, SourceLookup).
void	setNextReader(org.apache.lucene.index.LeafReaderContext context)	Update the leaf reader used to fetch values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.ValueFetcher

fetchDocumentField

Constructor Details

DocValueFetcher

public DocValueFetcher(DocValueFormat format,
 IndexFieldData<?> ifd)

Method Details

setNextReader

public void setNextReader(org.apache.lucene.index.LeafReaderContext context)

Description copied from interface: ValueFetcher

Update the leaf reader used to fetch values.

Specified by:

setNextReader in interface ValueFetcher

fetchValues

public List<Object> fetchValues(SourceLookup lookup,
 List<Object> ignoredValues)
                         throws IOException

Description copied from interface: ValueFetcher

This method is consumed by ValueFetcher.fetchDocumentField(String, SourceLookup). Given access to a document's _source, return this field's values.

In addition to pulling out the values, they will be parsed into a standard form. For example numeric field mappers make sure to parse the source value into a number of the right type.

Note that for array values, the order in which values are returned is undefined and should not be relied on.

Specified by:

fetchValues in interface ValueFetcher

Parameters:

lookup - a lookup structure over the document's source.

ignoredValues - a mutable list to collect any ignored values as they were originally presented in source

Returns:

a list a standardized field values.

Throws:

IOException