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

Class AbstractIndexField<S extends AbstractIndexField<S,SC,?,C>,SC extends SearchIndexScope<?>,NT extends SearchIndexNodeTypeContext<SC,? super S>,C extends IndexCompositeNode<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>

All Implemented Interfaces:

IndexField<SC,C>, IndexNode<SC>, IndexFieldDescriptor, SearchIndexNodeContext<SC>, EventContextProvider

Direct Known Subclasses:

AbstractIndexObjectField, AbstractIndexValueField

public abstract class AbstractIndexField<S extends AbstractIndexField<S,SC,?,C>,SC extends SearchIndexScope<?>,NT extends SearchIndexNodeTypeContext<SC,? super S>,C extends IndexCompositeNode<SC,?,?>>
extends AbstractIndexNode<S,SC,NT>
implements IndexField<SC,C>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	absolutePath
protected String[]	absolutePathComponents
protected IndexFieldInclusion	inclusion
protected boolean	multiValued
protected boolean	multiValuedInRoot
protected C	parent
protected String	relativeName

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

type

Constructor Summary

Constructors

Constructor	Description
AbstractIndexField(C parent, String relativeFieldName, NT type, IndexFieldInclusion inclusion, boolean multiValued)

Method Summary

Modifier and Type	Method	Description
String	absolutePath()
String[]	absolutePathComponents()
IndexFieldInclusion	inclusion()
boolean	multiValued()
boolean	multiValuedInRoot()
C	parent()
EventContext	relativeEventContext()
String	relativeName()
String	toString()

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

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

toComposite, toObjectField, toValueField

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

isObjectField, isValueField

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

isComposite, isValueField, nestedDocumentPath, nestedPathHierarchy, queryElement

Field Detail

parent

protected final C extends IndexCompositeNode<SC,?,?> parent

absolutePath

protected final String absolutePath

absolutePathComponents

protected final String[] absolutePathComponents

relativeName

protected final String relativeName

inclusion

protected final IndexFieldInclusion inclusion

multiValued

protected final boolean multiValued

multiValuedInRoot

protected final boolean multiValuedInRoot

Constructor Detail

AbstractIndexField

public AbstractIndexField(C parent,
                          String relativeFieldName,
                          NT type,
                          IndexFieldInclusion inclusion,
                          boolean multiValued)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

relativeEventContext

public final EventContext relativeEventContext()

Specified by:

relativeEventContext in interface SearchIndexNodeContext<S extends AbstractIndexField<S,SC,?,C>>

parent

public final C parent()

Specified by:

parent in interface IndexField<S extends AbstractIndexField<S,SC,?,C>,SC extends SearchIndexScope<?>>

Specified by:

parent in interface IndexFieldDescriptor

Returns:

The parent of this field, either the index root or an object field.

absolutePath

public final String absolutePath()

Specified by:

absolutePath in interface IndexFieldDescriptor

Specified by:

absolutePath in interface SearchIndexNodeContext<S extends AbstractIndexField<S,SC,?,C>>

Returns:

The absolute, dot-separated path of this field.

absolutePathComponents

public final String[] absolutePathComponents()

Specified by:

absolutePathComponents in interface SearchIndexNodeContext<S extends AbstractIndexField<S,SC,?,C>>

relativeName

public final String relativeName()

Specified by:

relativeName in interface IndexFieldDescriptor

Returns:

The name of this field relative to its parent.

inclusion

public final IndexFieldInclusion inclusion()

Specified by:

inclusion in interface IndexNode<S extends AbstractIndexField<S,SC,?,C>>

multiValued

public final boolean multiValued()

Specified by:

multiValued in interface IndexFieldDescriptor

Returns:

true if this field can have multiple values in the same parent document.

multiValuedInRoot

public final boolean multiValuedInRoot()

Specified by:

multiValuedInRoot in interface IndexFieldDescriptor

Specified by:

multiValuedInRoot in interface IndexNode<S extends AbstractIndexField<S,SC,?,C>>

Returns:

true if this field can have multiple values in the same root document or if it is contained, directly or indirectly, in an object field that can have multiple values.