Module org.elasticsearch.server

Package org.elasticsearch.search.lookup

Class SearchLookup

java.lang.Object

org.elasticsearch.search.lookup.SearchLookup

All Implemented Interfaces:

SourceProvider

public class SearchLookup
extends Object
implements SourceProvider

Provides a way to look up per-document values from docvalues, stored fields or _source

Constructor Summary

Constructors

Constructor	Description
SearchLookup(Function<String,MappedFieldType> fieldTypeLookup, TriFunction<MappedFieldType,Supplier<SearchLookup>,MappedFieldType.FielddataOperation,IndexFieldData<?>> fieldDataLookup, SourceProvider sourceProvider)	Create a new SearchLookup, using the default stored fields provider
SearchLookup(Function<String,MappedFieldType> fieldTypeLookup, TriFunction<MappedFieldType,Supplier<SearchLookup>,MappedFieldType.FielddataOperation,IndexFieldData<?>> fieldDataLookup, SourceProvider sourceProvider, Function<org.apache.lucene.index.LeafReaderContext,LeafFieldLookupProvider> fieldLookupProvider)	Create a new SearchLookup, using the default stored fields provider

Method Summary

Modifier and Type	Method	Description
MappedFieldType	fieldType(String fieldName)
final SearchLookup	forkAndTrackFieldReferences(String field)	Creates a copy of the current SearchLookup that looks fields up in the same way, but also tracks field references in order to detect cycles and prevent resolving fields that depend on more than MAX_FIELD_CHAIN_DEPTH other fields.
IndexFieldData<?>	getForField(MappedFieldType fieldType, MappedFieldType.FielddataOperation options)
LeafSearchLookup	getLeafSearchLookup(org.apache.lucene.index.LeafReaderContext context)
Source	getSource(org.apache.lucene.index.LeafReaderContext ctx, int doc)	Get the Source for the given doc within the given context

Methods inherited from class java.lang.Object

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

Constructor Details

SearchLookup

public SearchLookup(Function<String,MappedFieldType> fieldTypeLookup,
 TriFunction<MappedFieldType,Supplier<SearchLookup>,MappedFieldType.FielddataOperation,IndexFieldData<?>> fieldDataLookup,
 SourceProvider sourceProvider)

Create a new SearchLookup, using the default stored fields provider

Parameters:

fieldTypeLookup - defines how to look up field types

fieldDataLookup - defines how to look up field data

sourceProvider - defines how to look up the source

SearchLookup

public SearchLookup(Function<String,MappedFieldType> fieldTypeLookup,
 TriFunction<MappedFieldType,Supplier<SearchLookup>,MappedFieldType.FielddataOperation,IndexFieldData<?>> fieldDataLookup,
 SourceProvider sourceProvider,
 Function<org.apache.lucene.index.LeafReaderContext,LeafFieldLookupProvider> fieldLookupProvider)

Create a new SearchLookup, using the default stored fields provider

Parameters:

fieldTypeLookup - defines how to look up field types

fieldDataLookup - defines how to look up field data

sourceProvider - defines how to look up the source

fieldLookupProvider - defines how to look up stored fields

Method Details

forkAndTrackFieldReferences

public final SearchLookup forkAndTrackFieldReferences(String field)

Creates a copy of the current SearchLookup that looks fields up in the same way, but also tracks field references in order to detect cycles and prevent resolving fields that depend on more than MAX_FIELD_CHAIN_DEPTH other fields.

Parameters:

field - the field being referred to, for which fielddata needs to be loaded

Returns:

the new lookup

Throws:

IllegalArgumentException - if a cycle is detected in the fields required to build doc values, or if the field being resolved depends on more than MAX_FIELD_CHAIN_DEPTH

getLeafSearchLookup

public LeafSearchLookup getLeafSearchLookup(org.apache.lucene.index.LeafReaderContext context)

fieldType

public MappedFieldType fieldType(String fieldName)

getForField

public IndexFieldData<?> getForField(MappedFieldType fieldType,
 MappedFieldType.FielddataOperation options)

getSource

public Source getSource(org.apache.lucene.index.LeafReaderContext ctx,
 int doc)
                 throws IOException

Description copied from interface: SourceProvider

Get the Source for the given doc within the given context

Specified by:

getSource in interface SourceProvider

Throws:

IOException