Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class SortedNumericDocValuesSyntheticFieldLoaderLayer

java.lang.Object

org.elasticsearch.index.mapper.SortedNumericDocValuesSyntheticFieldLoaderLayer

All Implemented Interfaces:

CompositeSyntheticFieldLoader.DocValuesLayer, CompositeSyntheticFieldLoader.Layer, SourceLoader.SyntheticFieldLoader

public class SortedNumericDocValuesSyntheticFieldLoaderLayer
extends Object
implements CompositeSyntheticFieldLoader.DocValuesLayer

A CompositeSyntheticFieldLoader.DocValuesLayer that loads values from SortedNumericDocValues.

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
SortedNumericDocValuesSyntheticFieldLoaderLayer(String name, SortedNumericWithOffsetsDocValuesSyntheticFieldLoaderLayer.NumericValueWriter valueWriter)

Method Summary

Modifier and Type	Method	Description
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.
static org.apache.lucene.index.SortedNumericDocValues	docValuesOrNull(org.apache.lucene.index.LeafReader reader, String fieldName)	Returns a SortedNumericDocValues or null if it doesn't have any doc values.
String	fieldName()	Returns the canonical field name for this loader.
boolean	hasValue()	Has this field loaded any values for this document?
long	valueCount()	Number of values that this loader will write for a given document.
void	write(XContentBuilder b)	Write values for this document.

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.CompositeSyntheticFieldLoader.DocValuesLayer

reset, storedFieldLoaders

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

prepare, setIgnoredValues

Constructor Details

SortedNumericDocValuesSyntheticFieldLoaderLayer

public SortedNumericDocValuesSyntheticFieldLoaderLayer(String name,
 SortedNumericWithOffsetsDocValuesSyntheticFieldLoaderLayer.NumericValueWriter valueWriter)

Method Details

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

docValuesLoader

public 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

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

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:

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

docValuesOrNull

public static org.apache.lucene.index.SortedNumericDocValues docValuesOrNull(org.apache.lucene.index.LeafReader reader,
 String fieldName)
                                                                      throws IOException

Returns a SortedNumericDocValues or null if it doesn't have any doc values. See DocValues.getSortedNumeric(org.apache.lucene.index.LeafReader, java.lang.String) which is *nearly* the same, but it returns an "empty" implementation if there aren't any doc values. We need to be able to tell if there aren't any and return our empty leaf source loader.

Throws:

IOException