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

Class AbstractIndexField<S extends AbstractIndexField<S,SC,?,C>,SC extends SearchIndexScope<?>,NT extends AbstractIndexNodeType<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 AbstractIndexNodeType<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 final String	absolutePath
protected final String[]	absolutePathComponents
protected final TreeNodeInclusion	inclusion
protected final boolean	multiValued
protected final C	parent
protected final 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, TreeNodeInclusion inclusion, boolean multiValued)

Method Summary

Modifier and Type	Method	Description
final String	absolutePath()
final String[]	absolutePathComponents()
String	closestMultiValuedParentAbsolutePath()
final TreeNodeInclusion	inclusion()
final boolean	multiValued()
boolean	multiValuedInRoot()
final C	parent()
final EventContext	relativeEventContext()
final String	relativeName()
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.IndexField

toComposite, toObjectField, toValueField

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

isObjectField, isValueField, type

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

cannotUseQueryElement, isComposite, isObjectField, isValueField, nestedDocumentPath, nestedPathHierarchy, queryElement

Field Details

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 TreeNodeInclusion inclusion

multiValued

protected final boolean multiValued

Constructor Details

AbstractIndexField

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

Method Details

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 TreeNodeInclusion inclusion()

Specified by:

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

multiValued

public final boolean multiValued()

Specified by:

multiValued in interface IndexFieldDescriptor

Specified by:

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

Returns:

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

multiValuedInRoot

public boolean multiValuedInRoot()

Specified by:

multiValuedInRoot in interface IndexFieldDescriptor

Specified by:

multiValuedInRoot in interface SearchIndexNodeContext<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.

closestMultiValuedParentAbsolutePath

public String closestMultiValuedParentAbsolutePath()

Specified by:

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