Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class CompositeSyntheticFieldLoader.StoredFieldLayer

java.lang.Object

org.elasticsearch.index.mapper.CompositeSyntheticFieldLoader.StoredFieldLayer

All Implemented Interfaces:

CompositeSyntheticFieldLoader.Layer, SourceLoader.SyntheticFieldLoader

Direct Known Subclasses:

CompositeSyntheticFieldLoader.MalformedValuesLayer

Enclosing class:

CompositeSyntheticFieldLoader

public abstract static class CompositeSyntheticFieldLoader.StoredFieldLayer
extends Object
implements CompositeSyntheticFieldLoader.Layer

Layer that loads field values from a provided stored field.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.SourceLoader.SyntheticFieldLoader

SourceLoader.SyntheticFieldLoader.DocValuesLoader, SourceLoader.SyntheticFieldLoader.StoredFieldLoader

Field Summary

Fields inherited from interface org.elasticsearch.index.mapper.SourceLoader.SyntheticFieldLoader

NOTHING

Constructor Summary

Constructors

Constructor	Description
StoredFieldLayer(String fieldName)

Method Summary

Modifier and Type	Method	Description
SourceLoader.SyntheticFieldLoader.DocValuesLoader	docValuesLoader(org.apache.lucene.index.LeafReader leafReader, int[] docIdsInLeaf)	Build something to load doc values for this field or return null if there are no doc values for this field to load.
String	fieldName()	Returns the canonical field name for this loader.
boolean	hasValue()	Has this field loaded any values for this document?
void	reset()	Resets the loader to remove any stored data and prepare it for processing new document.
Stream<Map.Entry<String,SourceLoader.SyntheticFieldLoader.StoredFieldLoader>>	storedFieldLoaders()	A Stream mapping stored field paths to a place to put them so they can be included in the next document.
long	valueCount()	Number of values that this loader will write for a given document.
void	write(XContentBuilder b)	Write values for this document.
protected abstract void	writeValue(Object value, XContentBuilder b)	Write a value read from stored field using appropriate format.

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.SourceLoader.SyntheticFieldLoader

prepare, setIgnoredValues

Constructor Details

StoredFieldLayer

public StoredFieldLayer(String fieldName)

Method Details

valueCount

public long valueCount()

Description copied from interface: CompositeSyntheticFieldLoader.Layer

Number of values that this loader will write for a given document.

Specified by:

valueCount in interface CompositeSyntheticFieldLoader.Layer

Returns:

storedFieldLoaders

public Stream<Map.Entry<String,SourceLoader.SyntheticFieldLoader.StoredFieldLoader>> storedFieldLoaders()

Description copied from interface: SourceLoader.SyntheticFieldLoader

A Stream mapping stored field paths to a place to put them so they can be included in the next document.

Specified by:

storedFieldLoaders in interface SourceLoader.SyntheticFieldLoader

docValuesLoader

public SourceLoader.SyntheticFieldLoader.DocValuesLoader docValuesLoader(org.apache.lucene.index.LeafReader leafReader,
 int[] docIdsInLeaf)
                                                                  throws IOException

Description copied from interface: SourceLoader.SyntheticFieldLoader

Build something to load doc values for this field or return null if there are no doc values for this field to load.

Specified by:

docValuesLoader in interface SourceLoader.SyntheticFieldLoader

Parameters:

docIdsInLeaf - can be null.

Throws:

IOException

hasValue

public boolean hasValue()

Description copied from interface: SourceLoader.SyntheticFieldLoader

Has this field loaded any values for this document?

Specified by:

hasValue in interface SourceLoader.SyntheticFieldLoader

write

public void write(XContentBuilder b)
           throws IOException

Description copied from interface: SourceLoader.SyntheticFieldLoader

Write values for this document.

Specified by:

write in interface SourceLoader.SyntheticFieldLoader

Throws:

IOException

reset

public void reset()

Description copied from interface: SourceLoader.SyntheticFieldLoader

Resets the loader to remove any stored data and prepare it for processing new document. This is an alternative code path to SourceLoader.SyntheticFieldLoader.write(org.elasticsearch.xcontent.XContentBuilder) that is executed when values are loaded but not written. Loaders are expected to also reset their state after writing currently present data.

Specified by:

reset in interface SourceLoader.SyntheticFieldLoader

writeValue

protected abstract void writeValue(Object value,
 XContentBuilder b)
                            throws IOException

Write a value read from stored field using appropriate format.

Throws:

IOException

fieldName

public String fieldName()

Description copied from interface: SourceLoader.SyntheticFieldLoader

Returns the canonical field name for this loader.

Specified by:

fieldName in interface SourceLoader.SyntheticFieldLoader