Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class StringStoredFieldFieldLoader

java.lang.Object

org.elasticsearch.index.mapper.StringStoredFieldFieldLoader

All Implemented Interfaces:

SourceLoader.SyntheticFieldLoader

public abstract class StringStoredFieldFieldLoader
extends Object
implements SourceLoader.SyntheticFieldLoader

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
StringStoredFieldFieldLoader(String name, String simpleName)

Method Summary

Modifier and Type	Method	Description
final SourceLoader.SyntheticFieldLoader.DocValuesLoader	docValuesLoader(org.apache.lucene.index.LeafReader reader, 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.
final 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.
final 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.
final void	write(XContentBuilder b)	Write values for this document.
protected abstract void	write(XContentBuilder b, Object value)

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

setIgnoredValues

Constructor Details

StringStoredFieldFieldLoader

public StringStoredFieldFieldLoader(String name,
 String simpleName)

Method Details

storedFieldLoaders

public final 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

hasValue

public final 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 final 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

write

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

Throws:

IOException

docValuesLoader

public final SourceLoader.SyntheticFieldLoader.DocValuesLoader docValuesLoader(org.apache.lucene.index.LeafReader reader,
 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

docIdsInLeaf - can be null.

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