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

Class AbstractIndexRoot<S extends AbstractIndexRoot<S,SC,NT,F>,SC extends SearchIndexScope<?>,NT extends AbstractIndexCompositeNodeType<SC,? super S>,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.AbstractIndexRoot<S,SC,NT,F>

All Implemented Interfaces:

IndexCompositeNode<SC,NT,F>, IndexNode<SC>, IndexCompositeElementDescriptor, SearchIndexCompositeNodeContext<SC>, SearchIndexNodeContext<SC>, org.hibernate.search.util.common.reporting.spi.EventContextProvider

public abstract class AbstractIndexRoot<S extends AbstractIndexRoot<S,SC,NT,F>,SC extends SearchIndexScope<?>,NT extends AbstractIndexCompositeNodeType<SC,? super S>,F extends IndexField<SC,?>>
extends AbstractIndexNode<S,SC,NT>
implements IndexCompositeNode<SC,NT,F>

Field Summary

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

type

Constructor Summary

Constructors

Constructor	Description
AbstractIndexRoot(NT type, Map<String,F> notYetInitializedStaticChildren)

Method Summary

Modifier and Type	Method	Description
final String	absolutePath()
final String	absolutePath(String relativeFieldName)
final String[]	absolutePathComponents()
final String	closestMultiValuedParentAbsolutePath()
final TreeNodeInclusion	inclusion()
final boolean	isComposite()
final boolean	isObjectField()
final boolean	isRoot()
final boolean	isValueField()
final boolean	multiValued()
boolean	multiValuedInRoot()
final List<String>	nestedPathHierarchy()
final org.hibernate.search.util.common.reporting.EventContext	relativeEventContext()
final Map<String,F>	staticChildrenByName()	Get all statically-defined, direct child fields for this element, mapped by their relative name.
S	toComposite()
IndexObjectField<SC,?,?,?>	toObjectField()
String	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.IndexCompositeNode

staticChildren, type

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

toValueField

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

cannotUseQueryElement, nestedDocumentPath, queryElement

Constructor Details

AbstractIndexRoot

public AbstractIndexRoot(NT type,
 Map<String,F> notYetInitializedStaticChildren)

Method Details

toString

public String toString()

Overrides:

toString in class Object

relativeEventContext

public final org.hibernate.search.util.common.reporting.EventContext relativeEventContext()

Specified by:

relativeEventContext in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

isComposite

public final boolean isComposite()

Specified by:

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

isRoot

public final boolean isRoot()

Specified by:

isRoot in interface IndexCompositeElementDescriptor

Returns:

true if this element represents the root of the index.

isObjectField

public final boolean isObjectField()

Specified by:

isObjectField in interface IndexCompositeElementDescriptor

Specified by:

isObjectField in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

Returns:

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

isValueField

public final boolean isValueField()

Specified by:

isValueField in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

toComposite

public S toComposite()

Specified by:

toComposite in interface IndexNode<S extends AbstractIndexRoot<S,SC,NT,F>>

Specified by:

toComposite in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

toObjectField

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

Specified by:

toObjectField in interface IndexCompositeElementDescriptor

Specified by:

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

Specified by:

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

Returns:

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

absolutePath

public final String absolutePath()

Specified by:

absolutePath in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

absolutePath

public final String absolutePath(String relativeFieldName)

Specified by:

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

absolutePathComponents

public final String[] absolutePathComponents()

Specified by:

absolutePathComponents in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

inclusion

public final TreeNodeInclusion inclusion()

Specified by:

inclusion in interface IndexNode<S extends AbstractIndexRoot<S,SC,NT,F>>

nestedPathHierarchy

public final List<String> nestedPathHierarchy()

Specified by:

nestedPathHierarchy in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,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 AbstractIndexRoot<S,SC,NT,F>,SC extends SearchIndexScope<?>,NT extends AbstractIndexCompositeNodeType<SC,? super S>>

Specified by:

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

Returns:

A map containing all static child fields.

multiValued

public final boolean multiValued()

Specified by:

multiValued in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

multiValuedInRoot

public boolean multiValuedInRoot()

Specified by:

multiValuedInRoot in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>

closestMultiValuedParentAbsolutePath

public final String closestMultiValuedParentAbsolutePath()

Specified by:

closestMultiValuedParentAbsolutePath in interface SearchIndexNodeContext<S extends AbstractIndexRoot<S,SC,NT,F>>