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

Interface IndexCompositeNode<SC extends SearchIndexScope<?>,NT extends AbstractIndexCompositeNodeType<SC,?>,F extends IndexField<SC,?>>

All Superinterfaces:

EventContextProvider, IndexCompositeElementDescriptor, IndexNode<SC>, SearchIndexCompositeNodeContext<SC>, SearchIndexNodeContext<SC>

All Known Subinterfaces:

IndexObjectField<SC,NT,C,F>

All Known Implementing Classes:

AbstractIndexObjectField, AbstractIndexRoot

public interface IndexCompositeNode<SC extends SearchIndexScope<?>,NT extends AbstractIndexCompositeNodeType<SC,?>,F extends IndexField<SC,?>>
extends IndexNode<SC>, IndexCompositeElementDescriptor, SearchIndexCompositeNodeContext<SC>

Method Summary

Modifier and Type	Method	Description
default Collection<F>	staticChildren()	Get all statically-defined, direct child fields for this element.
Map<String,F>	staticChildrenByName()	Get all statically-defined, direct child fields for this element, mapped by their relative name.
NT	type()

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

eventContext

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

isObjectField, isRoot, toObjectField

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

inclusion, toComposite, toObjectField, toValueField

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

absolutePath

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

Method Details

type

NT type()

Specified by:

type in interface SearchIndexCompositeNodeContext<SC extends SearchIndexScope<?>>

staticChildren

default Collection<F> staticChildren()

Description copied from interface: IndexCompositeElementDescriptor

Get all statically-defined, direct child fields for this element.

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

Specified by:

staticChildren in interface IndexCompositeElementDescriptor

Returns:

A collection containing all static child fields.

staticChildrenByName

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 SearchIndexCompositeNodeContext<SC extends SearchIndexScope<?>>

Returns:

A map containing all static child fields.