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

Class LuceneIndexValueField<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<LuceneIndexValueField<F>,LuceneSearchIndexScope<?>,LuceneIndexValueFieldType<F>,LuceneIndexCompositeNode,F>

org.hibernate.search.backend.lucene.document.model.impl.LuceneIndexValueField<F>

All Implemented Interfaces:

LuceneIndexField, LuceneIndexNode, LuceneSearchEncodingContext<F>, LuceneSearchIndexNodeContext, LuceneSearchIndexValueFieldContext<F>, IndexField<LuceneSearchIndexScope<?>,LuceneIndexCompositeNode>, IndexNode<LuceneSearchIndexScope<?>>, IndexValueField<LuceneSearchIndexScope<?>,LuceneIndexValueFieldType<F>,LuceneIndexCompositeNode>, IndexFieldDescriptor, IndexValueFieldDescriptor, SearchIndexNodeContext<LuceneSearchIndexScope<?>>, SearchIndexValueFieldContext<LuceneSearchIndexScope<?>>, EventContextProvider

public final class LuceneIndexValueField<F>
extends AbstractIndexValueField<LuceneIndexValueField<F>,LuceneSearchIndexScope<?>,LuceneIndexValueFieldType<F>,LuceneIndexCompositeNode,F>
implements LuceneIndexField, LuceneSearchIndexValueFieldContext<F>, LuceneSearchEncodingContext<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
LuceneIndexValueField(LuceneIndexCompositeNode parent, String relativeFieldName, LuceneIndexValueFieldType<F> type, TreeNodeInclusion inclusion, boolean multiValued, boolean dynamic)

Method Summary

Modifier and Type	Method	Description
<E> E	convertAndEncode(LuceneSearchIndexScope<?> scope, LuceneSearchIndexValueFieldContext<F> field, LuceneFieldCodec<F,E> codec, Object value, ValueModel valueModel)
boolean	dynamic()
<E, T> Function<T,E>	encoder(LuceneSearchIndexScope<?> scope, LuceneSearchIndexValueFieldContext<F> field, LuceneFieldCodec<F,E> codec, Class<T> expectedType, ValueModel valueModel)
LuceneSearchEncodingContext<F>	encodingContext()
boolean	isCompatibleWith(LuceneSearchEncodingContext<?> other)
protected LuceneIndexValueField<F>	self()
LuceneIndexObjectField	toObjectField()
<T> LuceneIndexValueField<? 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.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.backend.lucene.document.model.impl.LuceneIndexNode

toComposite, toValueField

Methods inherited from interface org.hibernate.search.backend.lucene.search.common.impl.LuceneSearchIndexNodeContext

toComposite

Methods inherited from interface org.hibernate.search.backend.lucene.search.common.impl.LuceneSearchIndexValueFieldContext

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

LuceneIndexValueField

public LuceneIndexValueField(LuceneIndexCompositeNode parent,
 String relativeFieldName,
 LuceneIndexValueFieldType<F> type,
 TreeNodeInclusion inclusion,
 boolean multiValued,
 boolean dynamic)

Method Details

self

protected LuceneIndexValueField<F> self()

Specified by:

self in class AbstractIndexNode<LuceneIndexValueField<F>,LuceneSearchIndexScope<?>,LuceneIndexValueFieldType<F>>

toObjectField

public LuceneIndexObjectField toObjectField()

Specified by:

toObjectField in interface IndexField<LuceneSearchIndexScope<?>,LuceneIndexCompositeNode>

Specified by:

toObjectField in interface IndexFieldDescriptor

Specified by:

toObjectField in interface IndexNode<F>

Specified by:

toObjectField in interface LuceneIndexNode

Specified by:

toObjectField in interface LuceneSearchIndexNodeContext

Specified by:

toObjectField in interface SearchIndexNodeContext<F>

Overrides:

toObjectField in class AbstractIndexValueField<LuceneIndexValueField<F>,LuceneSearchIndexScope<?>,LuceneIndexValueFieldType<F>,LuceneIndexCompositeNode,F>

Returns:

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

dynamic

public boolean dynamic()

Specified by:

dynamic in interface LuceneIndexNode

withValueType

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

encoder

public <E,
T> Function<T,E> encoder(LuceneSearchIndexScope<?> scope,
 LuceneSearchIndexValueFieldContext<F> field,
 LuceneFieldCodec<F,E> codec,
 Class<T> expectedType,
 ValueModel valueModel)

Specified by:

encoder in interface LuceneSearchEncodingContext<F>

convertAndEncode

public <E> E convertAndEncode(LuceneSearchIndexScope<?> scope,
 LuceneSearchIndexValueFieldContext<F> field,
 LuceneFieldCodec<F,E> codec,
 Object value,
 ValueModel valueModel)

Specified by:

convertAndEncode in interface LuceneSearchEncodingContext<F>

isCompatibleWith

public boolean isCompatibleWith(LuceneSearchEncodingContext<?> other)

Specified by:

isCompatibleWith in interface LuceneSearchEncodingContext<F>

encodingContext

public LuceneSearchEncodingContext<F> encodingContext()

Specified by:

encodingContext in interface LuceneSearchIndexValueFieldContext<F>