Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class BinaryDocValuesSyntheticFieldLoader

java.lang.Object

org.elasticsearch.index.mapper.SourceLoader.DocValuesBasedSyntheticFieldLoader

org.elasticsearch.index.mapper.BinaryDocValuesSyntheticFieldLoader

All Implemented Interfaces:

SourceLoader.SyntheticFieldLoader

public abstract class BinaryDocValuesSyntheticFieldLoader
extends SourceLoader.DocValuesBasedSyntheticFieldLoader

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

Modifier	Constructor	Description
protected	BinaryDocValuesSyntheticFieldLoader(String name)

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	write(XContentBuilder b)	Write values for this document.
protected abstract void	writeValue(XContentBuilder b, org.apache.lucene.util.BytesRef value)

Methods inherited from class org.elasticsearch.index.mapper.SourceLoader.DocValuesBasedSyntheticFieldLoader

reset, storedFieldLoaders

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

BinaryDocValuesSyntheticFieldLoader

protected BinaryDocValuesSyntheticFieldLoader(String name)

Method Details

writeValue

protected abstract void writeValue(XContentBuilder b,
 org.apache.lucene.util.BytesRef value)
                            throws IOException

Throws:

IOException

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.

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?

write

public void write(XContentBuilder b)
           throws IOException

Description copied from interface: SourceLoader.SyntheticFieldLoader

Write values for this document.

Throws:

IOException

fieldName

public String fieldName()

Description copied from interface: SourceLoader.SyntheticFieldLoader

Returns the canonical field name for this loader.