Package org.hibernate.search.backend.elasticsearch.document.model.impl

Class ElasticsearchIndexValueField<F>

java.lang.Object

org.hibernate.search.engine.backend.document.model.spi.AbstractIndexNode<S,SC,NT>

org.hibernate.search.engine.backend.document.model.spi.AbstractIndexField<S,SC,FT,C>

org.hibernate.search.engine.backend.document.model.spi.AbstractIndexValueField<ElasticsearchIndexValueField<F>,ElasticsearchSearchIndexScope<?>,ElasticsearchIndexValueFieldType<F>,ElasticsearchIndexCompositeNode,F>

org.hibernate.search.backend.elasticsearch.document.model.impl.ElasticsearchIndexValueField<F>

All Implemented Interfaces:

ElasticsearchIndexField, ElasticsearchIndexNode, ElasticsearchSearchEncodingContext<F>, ElasticsearchSearchIndexNodeContext, ElasticsearchSearchIndexValueFieldContext<F>, IndexField<ElasticsearchSearchIndexScope<?>,ElasticsearchIndexCompositeNode>, IndexNode<ElasticsearchSearchIndexScope<?>>, IndexValueField<ElasticsearchSearchIndexScope<?>,ElasticsearchIndexValueFieldType<F>,ElasticsearchIndexCompositeNode>, IndexFieldDescriptor, IndexValueFieldDescriptor, SearchIndexNodeContext<ElasticsearchSearchIndexScope<?>>, SearchIndexValueFieldContext<ElasticsearchSearchIndexScope<?>>, EventContextProvider

public final class ElasticsearchIndexValueField<F>
extends AbstractIndexValueField<ElasticsearchIndexValueField<F>,ElasticsearchSearchIndexScope<?>,ElasticsearchIndexValueFieldType<F>,ElasticsearchIndexCompositeNode,F>
implements ElasticsearchIndexField, ElasticsearchSearchIndexValueFieldContext<F>, ElasticsearchSearchEncodingContext<F>

Field Summary

Fields inherited from class org.hibernate.search.engine.backend.document.model.spi.AbstractIndexField

absolutePath, absolutePathComponents, inclusion, multiValued, parent, relativeName

Fields inherited from class org.hibernate.search.engine.backend.document.model.spi.AbstractIndexNode

type

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIndexValueField(ElasticsearchIndexCompositeNode parent, String relativeFieldName, ElasticsearchIndexValueFieldType<F> type, TreeNodeInclusion inclusion, boolean multiValued)

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonElement	convertAndEncode(ElasticsearchSearchIndexScope<?> scope, ElasticsearchSearchIndexValueFieldContext<F> field, Object value, ValueModel valueModel, BiFunction<ElasticsearchFieldCodec<F>,F,com.google.gson.JsonElement> encodeFunction)
<T> Function<T,com.google.gson.JsonElement>	encoder(ElasticsearchSearchIndexScope<?> scope, ElasticsearchSearchIndexValueFieldContext<F> field, Class<T> expectedType, ValueModel valueModel)
ElasticsearchSearchEncodingContext<F>	encodingContext()
boolean	isCompatibleWith(ElasticsearchSearchEncodingContext<?> other)
protected ElasticsearchIndexValueField<F>	self()
ElasticsearchIndexObjectField	toObjectField()
<T> ElasticsearchIndexValueField<? super T>	withValueType(Class<T> expectedSubType, EventContext eventContext)

Methods inherited from class org.hibernate.search.engine.backend.document.model.spi.AbstractIndexValueField

isComposite, isObjectField, isValueField, nestedPathHierarchy, toComposite, toValueField

Methods inherited from class org.hibernate.search.engine.backend.document.model.spi.AbstractIndexField

absolutePath, absolutePathComponents, closestMultiValuedParentAbsolutePath, inclusion, multiValued, multiValuedInRoot, parent, relativeEventContext, relativeName, toString

Methods inherited from class org.hibernate.search.engine.backend.document.model.spi.AbstractIndexNode

cannotUseQueryElement, eventContext, queryElement, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.backend.elasticsearch.document.model.impl.ElasticsearchIndexNode

toComposite, toValueField

Methods inherited from interface org.hibernate.search.backend.elasticsearch.search.common.impl.ElasticsearchSearchIndexNodeContext

toComposite, toValueField

Methods inherited from interface org.hibernate.search.backend.elasticsearch.search.common.impl.ElasticsearchSearchIndexValueFieldContext

type

Methods inherited from interface org.hibernate.search.util.common.reporting.spi.EventContextProvider

eventContext

Methods inherited from interface org.hibernate.search.engine.backend.document.model.spi.IndexField

parent, toComposite, toValueField

Methods inherited from interface org.hibernate.search.engine.backend.metamodel.IndexFieldDescriptor

absolutePath, isObjectField, isValueField, multiValued, multiValuedInRoot, relativeName

Methods inherited from interface org.hibernate.search.engine.backend.document.model.spi.IndexNode

inclusion

Methods inherited from interface org.hibernate.search.engine.backend.document.model.spi.IndexValueField

type

Methods inherited from interface org.hibernate.search.engine.search.common.spi.SearchIndexNodeContext

absolutePath, absolutePathComponents, cannotUseQueryElement, closestMultiValuedParentAbsolutePath, isComposite, isObjectField, isValueField, multiValued, multiValuedInRoot, nestedDocumentPath, nestedPathHierarchy, queryElement, relativeEventContext

Constructor Details

ElasticsearchIndexValueField

public ElasticsearchIndexValueField(ElasticsearchIndexCompositeNode parent,
 String relativeFieldName,
 ElasticsearchIndexValueFieldType<F> type,
 TreeNodeInclusion inclusion,
 boolean multiValued)

Method Details

self

protected ElasticsearchIndexValueField<F> self()

Specified by:

self in class AbstractIndexNode<ElasticsearchIndexValueField<F>,ElasticsearchSearchIndexScope<?>,ElasticsearchIndexValueFieldType<F>>

toObjectField

public ElasticsearchIndexObjectField toObjectField()

Specified by:

toObjectField in interface ElasticsearchIndexNode

Specified by:

toObjectField in interface ElasticsearchSearchIndexNodeContext

Specified by:

toObjectField in interface IndexField<ElasticsearchSearchIndexScope<?>,ElasticsearchIndexCompositeNode>

Specified by:

toObjectField in interface IndexFieldDescriptor

Specified by:

toObjectField in interface IndexNode<F>

Specified by:

toObjectField in interface SearchIndexNodeContext<F>

Overrides:

toObjectField in class AbstractIndexValueField<ElasticsearchIndexValueField<F>,ElasticsearchSearchIndexScope<?>,ElasticsearchIndexValueFieldType<F>,ElasticsearchIndexCompositeNode,F>

Returns:

This field as an IndexObjectFieldDescriptor, if possible. Never null.

withValueType

public <T> ElasticsearchIndexValueField<? super T> withValueType(Class<T> expectedSubType,
 EventContext eventContext)

encoder

public <T> Function<T,com.google.gson.JsonElement> encoder(ElasticsearchSearchIndexScope<?> scope,
 ElasticsearchSearchIndexValueFieldContext<F> field,
 Class<T> expectedType,
 ValueModel valueModel)

Specified by:

encoder in interface ElasticsearchSearchEncodingContext<F>

convertAndEncode

public com.google.gson.JsonElement convertAndEncode(ElasticsearchSearchIndexScope<?> scope,
 ElasticsearchSearchIndexValueFieldContext<F> field,
 Object value,
 ValueModel valueModel,
 BiFunction<ElasticsearchFieldCodec<F>,F,com.google.gson.JsonElement> encodeFunction)

Specified by:

convertAndEncode in interface ElasticsearchSearchEncodingContext<F>

isCompatibleWith

public boolean isCompatibleWith(ElasticsearchSearchEncodingContext<?> other)

Specified by:

isCompatibleWith in interface ElasticsearchSearchEncodingContext<F>

encodingContext

public ElasticsearchSearchEncodingContext<F> encodingContext()

Specified by:

encodingContext in interface ElasticsearchSearchIndexValueFieldContext<F>