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

Class LuceneIndexRoot

java.lang.Object

org.hibernate.search.engine.backend.document.model.spi.AbstractIndexNode<S,SC,NT>

org.hibernate.search.engine.backend.document.model.spi.AbstractIndexRoot<LuceneIndexRoot,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexField>

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

All Implemented Interfaces:

LuceneIndexCompositeNode, LuceneIndexNode, LuceneSearchIndexCompositeNodeContext, LuceneSearchIndexNodeContext, IndexCompositeNode<LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexField>, IndexNode<LuceneSearchIndexScope<?>>, IndexCompositeElementDescriptor, SearchIndexCompositeNodeContext<LuceneSearchIndexScope<?>>, SearchIndexNodeContext<LuceneSearchIndexScope<?>>, EventContextProvider

public final class LuceneIndexRoot
extends AbstractIndexRoot<LuceneIndexRoot,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexField>
implements LuceneIndexCompositeNode

Field Summary

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

type

Constructor Summary

Constructors

Constructor	Description
LuceneIndexRoot(LuceneIndexCompositeNodeType type, Map<String,LuceneIndexField> notYetInitializedStaticChildren)

Method Summary

Modifier and Type	Method	Description
boolean	dynamic()
protected LuceneIndexRoot	self()
LuceneIndexObjectField	toObjectField()
LuceneIndexValueField<?>	toValueField()

Methods inherited from class org.hibernate.search.engine.backend.document.model.spi.AbstractIndexRoot

absolutePath, absolutePath, absolutePathComponents, closestMultiValuedParentAbsolutePath, inclusion, isComposite, isObjectField, isRoot, isValueField, multiValued, multiValuedInRoot, nestedPathHierarchy, relativeEventContext, staticChildrenByName, toComposite, 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.metamodel.IndexCompositeElementDescriptor

isObjectField, isRoot

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

staticChildren, staticChildrenByName, type

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

inclusion

Methods inherited from interface org.hibernate.search.backend.lucene.document.model.impl.LuceneIndexNode

toComposite

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

staticChildrenByName, type

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

toComposite

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

Constructor Detail

LuceneIndexRoot

public LuceneIndexRoot(LuceneIndexCompositeNodeType type,
                       Map<String,LuceneIndexField> notYetInitializedStaticChildren)

Method Detail

self

protected LuceneIndexRoot self()

Specified by:

self in class AbstractIndexNode<LuceneIndexRoot,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType>

toObjectField

public LuceneIndexObjectField toObjectField()

Specified by:

toObjectField in interface IndexCompositeElementDescriptor

Specified by:

toObjectField in interface IndexNode<LuceneSearchIndexScope<?>>

Specified by:

toObjectField in interface LuceneIndexNode

Specified by:

toObjectField in interface LuceneSearchIndexNodeContext

Specified by:

toObjectField in interface SearchIndexNodeContext<LuceneSearchIndexScope<?>>

Overrides:

toObjectField in class AbstractIndexRoot<LuceneIndexRoot,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexField>

Returns:

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

toValueField

public LuceneIndexValueField<?> toValueField()

Specified by:

toValueField in interface IndexNode<LuceneSearchIndexScope<?>>

Specified by:

toValueField in interface LuceneIndexNode

Specified by:

toValueField in interface SearchIndexNodeContext<LuceneSearchIndexScope<?>>

dynamic

public boolean dynamic()

Specified by:

dynamic in interface LuceneIndexNode