Package org.hibernate.search.engine.backend.document.model.spi

Class AbstractIndexValueField<S extends AbstractIndexValueField<S,SC,FT,C,F>,SC extends SearchIndexScope<?>,FT extends AbstractIndexValueFieldType<SC,? super S,F>,C extends IndexCompositeNode<SC,?,?>,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<S,SC,FT,C,F>

All Implemented Interfaces:

IndexField<SC,C>, IndexNode<SC>, IndexValueField<SC,FT,C>, IndexFieldDescriptor, IndexValueFieldDescriptor, SearchIndexNodeContext<SC>, SearchIndexValueFieldContext<SC>, EventContextProvider

public abstract class AbstractIndexValueField<S extends AbstractIndexValueField<S,SC,FT,C,F>,SC extends SearchIndexScope<?>,FT extends AbstractIndexValueFieldType<SC,? super S,F>,C extends IndexCompositeNode<SC,?,?>,F>
extends AbstractIndexField<S,SC,FT,C>
implements IndexValueField<SC,FT,C>, SearchIndexValueFieldContext<SC>

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
AbstractIndexValueField(C parent, String relativeFieldName, FT type, TreeNodeInclusion inclusion, boolean multiValued)

Method Summary

Modifier and Type	Method	Description
final boolean	isComposite()
final boolean	isObjectField()
final boolean	isValueField()
List<String>	nestedPathHierarchy()
final C	toComposite()
IndexObjectField<SC,?,C,?>	toObjectField()
final S	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, self, 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

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

absolutePath, 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, multiValued, multiValuedInRoot, nestedDocumentPath, queryElement, relativeEventContext

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

type

Constructor Details

AbstractIndexValueField

public AbstractIndexValueField(C parent,
 String relativeFieldName,
 FT type,
 TreeNodeInclusion inclusion,
 boolean multiValued)

Method Details

isComposite

public final boolean isComposite()

Specified by:

isComposite in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>

isObjectField

public final boolean isObjectField()

Specified by:

isObjectField in interface IndexFieldDescriptor

Specified by:

isObjectField in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Returns:

true if this field is an object field. In that case, IndexFieldDescriptor.toObjectField() can be called safely (it won't throw an exception).

isValueField

public final boolean isValueField()

Specified by:

isValueField in interface IndexFieldDescriptor

Specified by:

isValueField in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Returns:

true if this field is a value field. In that case, IndexFieldDescriptor.toValueField() can be called safely (it won't throw an exception).

toComposite

public final C toComposite()

Specified by:

toComposite in interface IndexField<S extends AbstractIndexValueField<S,SC,FT,C,F>,SC extends SearchIndexScope<?>>

Specified by:

toComposite in interface IndexNode<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Specified by:

toComposite in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>

toObjectField

public IndexObjectField<SC,?,C,?> toObjectField()

Specified by:

toObjectField in interface IndexField<S extends AbstractIndexValueField<S,SC,FT,C,F>,SC extends SearchIndexScope<?>>

Specified by:

toObjectField in interface IndexFieldDescriptor

Specified by:

toObjectField in interface IndexNode<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Specified by:

toObjectField in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Returns:

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

toValueField

public final S toValueField()

Specified by:

toValueField in interface IndexField<S extends AbstractIndexValueField<S,SC,FT,C,F>,SC extends SearchIndexScope<?>>

Specified by:

toValueField in interface IndexFieldDescriptor

Specified by:

toValueField in interface IndexNode<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Specified by:

toValueField in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>

Returns:

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

nestedPathHierarchy

public List<String> nestedPathHierarchy()

Specified by:

nestedPathHierarchy in interface SearchIndexNodeContext<S extends AbstractIndexValueField<S,SC,FT,C,F>>