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

Class LuceneIndexObjectField

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<LuceneIndexObjectField,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexCompositeNode,LuceneIndexField>

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

All Implemented Interfaces:

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

public final class LuceneIndexObjectField
extends AbstractIndexObjectField<LuceneIndexObjectField,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexCompositeNode,LuceneIndexField>
implements LuceneIndexCompositeNode, LuceneIndexField

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
LuceneIndexObjectField(LuceneIndexCompositeNode parent, String relativeFieldName, LuceneIndexCompositeNodeType type, TreeNodeInclusion inclusion, boolean multiValued, Map<String,LuceneIndexField> notYetInitializedStaticChildren, boolean dynamic)

Method Summary

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

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

absolutePath, isComposite, isObjectField, isRoot, isValueField, nestedPathHierarchy, staticChildrenByName, toObjectField

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, 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, toObjectField

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.IndexField

parent, toObjectField

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

absolutePath, isObjectField, isValueField, 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.metamodel.IndexObjectFieldDescriptor

type

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

toObjectField

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

toObjectField

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

LuceneIndexObjectField

public LuceneIndexObjectField(LuceneIndexCompositeNode parent,
                              String relativeFieldName,
                              LuceneIndexCompositeNodeType type,
                              TreeNodeInclusion inclusion,
                              boolean multiValued,
                              Map<String,LuceneIndexField> notYetInitializedStaticChildren,
                              boolean dynamic)

Method Detail

self

protected LuceneIndexObjectField self()

Specified by:

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

toComposite

public LuceneIndexCompositeNode toComposite()

Specified by:

toComposite in interface IndexField<LuceneSearchIndexScope<?>,LuceneIndexCompositeNode>

Specified by:

toComposite in interface IndexNode<LuceneSearchIndexScope<?>>

Specified by:

toComposite in interface LuceneIndexNode

Specified by:

toComposite in interface LuceneSearchIndexNodeContext

Specified by:

toComposite in interface SearchIndexNodeContext<LuceneSearchIndexScope<?>>

toValueField

public LuceneIndexValueField<?> toValueField()

Specified by:

toValueField in interface IndexField<LuceneSearchIndexScope<?>,LuceneIndexCompositeNode>

Specified by:

toValueField in interface IndexFieldDescriptor

Specified by:

toValueField in interface IndexNode<LuceneSearchIndexScope<?>>

Specified by:

toValueField in interface LuceneIndexNode

Specified by:

toValueField in interface SearchIndexNodeContext<LuceneSearchIndexScope<?>>

Overrides:

toValueField in class AbstractIndexObjectField<LuceneIndexObjectField,LuceneSearchIndexScope<?>,LuceneIndexCompositeNodeType,LuceneIndexCompositeNode,LuceneIndexField>

Returns:

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

dynamic

public boolean dynamic()

Specified by:

dynamic in interface LuceneIndexNode