Class AbstractIndexObjectField<S extends AbstractIndexObjectField<S,SC,NT,C,F>, SC extends SearchIndexScope<?>, NT extends AbstractIndexCompositeNodeType<SC, ? super S>, C extends IndexCompositeNode<SC,NT,F>, F extends IndexField<SC,?>>

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,NT,C>

org.hibernate.search.engine.backend.document.model.spi.AbstractIndexObjectField<S,SC,NT,C,F>

All Implemented Interfaces:

IndexCompositeNode<SC,NT,F>, IndexField<SC,C>, IndexNode<SC>, IndexObjectField<SC,NT,C,F>, IndexCompositeElementDescriptor, IndexFieldDescriptor, IndexObjectFieldDescriptor, SearchIndexCompositeNodeContext<SC>, SearchIndexNodeContext<SC>, EventContextProvider

public abstract class AbstractIndexObjectField<S extends AbstractIndexObjectField<S,SC,NT,C,F>, SC extends SearchIndexScope<?>, NT extends AbstractIndexCompositeNodeType<SC, ? super S>, C extends IndexCompositeNode<SC,NT,F>, F extends IndexField<SC,?>>
extends AbstractIndexField<S,SC,NT,C>
implements IndexObjectField<SC,NT,C,F>

Field Summary

Fields inherited from class AbstractIndexField

absolutePath, absolutePathComponents, inclusion, multiValued, parent, relativeName

Fields inherited from class AbstractIndexNode

type

Constructor Summary

Constructors

Constructor	Description
AbstractIndexObjectField(C parent, String relativeFieldName, NT type, TreeNodeInclusion inclusion, boolean multiValued, Map<String,F> notYetInitializedStaticChildren)

Method Summary

Modifier and Type	Method	Description
final String	absolutePath(String relativeFieldName)
final boolean	isComposite()
final boolean	isObjectField()
final boolean	isRoot()
final boolean	isValueField()
final List<String>	nestedPathHierarchy()
final Map<String,F>	staticChildrenByName()	Get all statically-defined, direct child fields for this element, mapped by their relative name.
final S	toObjectField()
IndexValueField<SC,?,C>	toValueField()

Methods inherited from class AbstractIndexField

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

Methods inherited from class AbstractIndexNode

cannotUseQueryElement, eventContext, queryElement, self, type

Methods inherited from class Object

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

Methods inherited from interface EventContextProvider

eventContext

Methods inherited from interface IndexCompositeNode

staticChildren, type

Methods inherited from interface IndexField

parent, toComposite

Methods inherited from interface IndexFieldDescriptor

absolutePath, multiValued, multiValuedInRoot, relativeName

Methods inherited from interface IndexNode

inclusion

Methods inherited from interface IndexObjectFieldDescriptor

type

Methods inherited from interface SearchIndexNodeContext

absolutePath, absolutePathComponents, cannotUseQueryElement, closestMultiValuedParentAbsolutePath, multiValued, multiValuedInRoot, nestedDocumentPath, queryElement, relativeEventContext

Constructor Details

AbstractIndexObjectField

public AbstractIndexObjectField(C parent,
 String relativeFieldName,
 NT type,
 TreeNodeInclusion inclusion,
 boolean multiValued,
 Map<String,F> notYetInitializedStaticChildren)

Method Details

isRoot

public final boolean isRoot()

Specified by:

isRoot in interface IndexCompositeElementDescriptor

Returns:

true if this element represents the root of the index.

isComposite

public final boolean isComposite()

Specified by:

isComposite in interface SearchIndexNodeContext<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

isObjectField

public final boolean isObjectField()

Specified by:

isObjectField in interface IndexCompositeElementDescriptor

Specified by:

isObjectField in interface IndexFieldDescriptor

Specified by:

isObjectField in interface SearchIndexNodeContext<S extends AbstractIndexObjectField<S,SC,NT,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 AbstractIndexObjectField<S,SC,NT,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).

toObjectField

public final S toObjectField()

Specified by:

toObjectField in interface IndexCompositeElementDescriptor

Specified by:

toObjectField in interface IndexField<S extends AbstractIndexObjectField<S,SC,NT,C,F>, SC extends SearchIndexScope<?>>

Specified by:

toObjectField in interface IndexFieldDescriptor

Specified by:

toObjectField in interface IndexNode<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

Specified by:

toObjectField in interface SearchIndexNodeContext<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

Returns:

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

toValueField

public IndexValueField<SC,?,C> toValueField()

Specified by:

toValueField in interface IndexField<S extends AbstractIndexObjectField<S,SC,NT,C,F>, SC extends SearchIndexScope<?>>

Specified by:

toValueField in interface IndexFieldDescriptor

Specified by:

toValueField in interface IndexNode<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

Specified by:

toValueField in interface SearchIndexNodeContext<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

Returns:

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

absolutePath

public final String absolutePath(String relativeFieldName)

Specified by:

absolutePath in interface SearchIndexCompositeNodeContext<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

nestedPathHierarchy

public final List<String> nestedPathHierarchy()

Specified by:

nestedPathHierarchy in interface SearchIndexNodeContext<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

staticChildrenByName

public final Map<String,F> staticChildrenByName()

Description copied from interface: IndexCompositeElementDescriptor

Get all statically-defined, direct child fields for this element, mapped by their relative name.

Only statically-defined fields are returned; fields created dynamically through templates are not included in the map.

Specified by:

staticChildrenByName in interface IndexCompositeElementDescriptor

Specified by:

staticChildrenByName in interface IndexCompositeNode<S extends AbstractIndexObjectField<S,SC,NT,C,F>, SC extends SearchIndexScope<?>, NT extends AbstractIndexCompositeNodeType<SC, ? super S>>

Specified by:

staticChildrenByName in interface SearchIndexCompositeNodeContext<S extends AbstractIndexObjectField<S,SC,NT,C,F>>

Returns:

A map containing all static child fields.