Package org.hibernate.search.mapper.pojo.model.dependency.impl

Class PojoPropertyIndexingDependencyConfigurationContextImpl<P>

java.lang.Object

org.hibernate.search.mapper.pojo.model.dependency.impl.AbstractPojoBridgedElementDependencyContext

org.hibernate.search.mapper.pojo.model.dependency.impl.PojoPropertyIndexingDependencyConfigurationContextImpl<P>

All Implemented Interfaces:

PojoPropertyIndexingDependencyConfigurationContext

public class PojoPropertyIndexingDependencyConfigurationContextImpl<P>
extends AbstractPojoBridgedElementDependencyContext
implements PojoPropertyIndexingDependencyConfigurationContext

Constructor Summary

Constructors

Constructor	Description
PojoPropertyIndexingDependencyConfigurationContextImpl(PojoBootstrapIntrospector introspector, ContainerExtractorBinder containerExtractorBinder, PojoTypeAdditionalMetadataProvider typeAdditionalMetadataProvider, BoundPojoModelPathPropertyNode<?,P> modelPath)

Method Summary

Modifier and Type	Method	Description
void	contributeDependencies(PojoIndexingDependencyCollectorPropertyNode<?,P> dependencyCollector)
PojoOtherEntityIndexingDependencyConfigurationContext	fromOtherEntity(ContainerExtractorPath extractorPathFromBridgedProperty, Class<?> otherEntityType, PojoModelPathValueNode pathFromOtherEntityTypeToBridgedPropertyExtractedType)	Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.
boolean	hasNonRootDependency()
PojoPropertyIndexingDependencyConfigurationContext	use(ContainerExtractorPath extractorPathFromBridgedProperty, PojoModelPathValueNode pathFromExtractedBridgedPropertyValueToUsedValue)	Declare that the given path is read by the bridge at index time to populate the indexed document.
void	useRootOnly()	Declare that the bridge will only use the property value directly, and will not access any mutable property nested in the property value.

Methods inherited from class org.hibernate.search.mapper.pojo.model.dependency.impl.AbstractPojoBridgedElementDependencyContext

isUseRootOnly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.mapper.pojo.model.dependency.PojoPropertyIndexingDependencyConfigurationContext

fromOtherEntity, fromOtherEntity, use, use, use

Constructor Detail

PojoPropertyIndexingDependencyConfigurationContextImpl

public PojoPropertyIndexingDependencyConfigurationContextImpl(PojoBootstrapIntrospector introspector,
                                                              ContainerExtractorBinder containerExtractorBinder,
                                                              PojoTypeAdditionalMetadataProvider typeAdditionalMetadataProvider,
                                                              BoundPojoModelPathPropertyNode<?,P> modelPath)

Method Detail

use

public PojoPropertyIndexingDependencyConfigurationContext use(ContainerExtractorPath extractorPathFromBridgedProperty,
                                                              PojoModelPathValueNode pathFromExtractedBridgedPropertyValueToUsedValue)

Description copied from interface: PojoPropertyIndexingDependencyConfigurationContext

Declare that the given path is read by the bridge at index time to populate the indexed document.

Every component of this path will be considered as a dependency, so it is not necessary to call this method for every subpath. In other words, if the path "myProperty.someOtherProperty" is declared as used, Hibernate Search will automatically assume that "myProperty" is also used.

Specified by:

use in interface PojoPropertyIndexingDependencyConfigurationContext

Parameters:

extractorPathFromBridgedProperty - A container extractor path from the bridged property.

pathFromExtractedBridgedPropertyValueToUsedValue - The path from the values extracted from the bridged property to the values used by the bridge.

Returns:

this, for method chaining.

See Also:

PojoPropertyIndexingDependencyConfigurationContext.use(ContainerExtractorPath, PojoModelPathValueNode)

fromOtherEntity

public PojoOtherEntityIndexingDependencyConfigurationContext fromOtherEntity(ContainerExtractorPath extractorPathFromBridgedProperty,
                                                                             Class<?> otherEntityType,
                                                                             PojoModelPathValueNode pathFromOtherEntityTypeToBridgedPropertyExtractedType)

Description copied from interface: PojoPropertyIndexingDependencyConfigurationContext

Start the declaration of dependencies to properties of another entity, without specifying the path to that other entity.

Note: this is only useful when the path from the bridged type to that other entity cannot be easily represented, but the inverse path can. For almost all use cases, this method won't be useful and calling PojoPropertyIndexingDependencyConfigurationContext.use(PojoModelPathValueNode) will be enough.

Specified by:

fromOtherEntity in interface PojoPropertyIndexingDependencyConfigurationContext

Parameters:

extractorPathFromBridgedProperty - A container extractor path from the bridged property.

otherEntityType - The raw type of the other entity.

pathFromOtherEntityTypeToBridgedPropertyExtractedType - The path from the other entity type to the type of extracted values for the bridged property. Used when the other entity changes, to collect the instances that must be reindexed.

Returns:

A context allowing to declare which properties

useRootOnly

public void useRootOnly()

Description copied from interface: PojoPropertyIndexingDependencyConfigurationContext

Declare that the bridge will only use the property value directly, and will not access any mutable property nested in the property value.

This is unusual, and generally only possible for bridges that are applied to immutable types (String, an enum, ...) or collections of immutable types (List<String>, ...), or that do not rely on the bridged element at all (constant bridges, bridges adding the last indexing date, ...).

Note that calling this method prevents from declaring any other dependency, and trying to do so will trigger an exception.

Specified by:

useRootOnly in interface PojoPropertyIndexingDependencyConfigurationContext

Overrides:

useRootOnly in class AbstractPojoBridgedElementDependencyContext

hasNonRootDependency

public boolean hasNonRootDependency()

Specified by:

hasNonRootDependency in class AbstractPojoBridgedElementDependencyContext

contributeDependencies

public void contributeDependencies(PojoIndexingDependencyCollectorPropertyNode<?,P> dependencyCollector)