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

Interface PojoRoutingIndexingDependencyConfigurationContext

public interface PojoRoutingIndexingDependencyConfigurationContext

Method Summary

Modifier and Type	Method	Description
default PojoRoutingIndexingDependencyConfigurationContext	use(String pathFromEntityTypeToUsedValue)	Declare that the given path is read by the bridge at indexing time to route the indexed document.
PojoRoutingIndexingDependencyConfigurationContext	use(PojoModelPathValueNode pathFromEntityTypeToUsedValue)	Declare that the given path is read by the bridge at indexing time to route the indexed document.
void	useRootOnly()	Declare that the bridge will only use the indexed entity directly, and will not access any mutable property.

Method Detail

useRootOnly

void useRootOnly()

Declare that the bridge will only use the indexed entity directly, and will not access any mutable property.

This is generally called for bridges that rely exclusively on the identifier for routing.

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

use

default PojoRoutingIndexingDependencyConfigurationContext use(String pathFromEntityTypeToUsedValue)

Declare that the given path is read by the bridge at indexing time to route the indexed document.

Parameters:

pathFromEntityTypeToUsedValue - The path from the indexed entity type to the value used by the bridge, as a String. The string is interpreted with default value extractors: see PojoModelPath.parse(String).

Returns:

this, for method chaining.

Throws:

SearchException - If the given path cannot be applied to the indexed entity type.

See Also:

use(PojoModelPathValueNode)

use

PojoRoutingIndexingDependencyConfigurationContext use(PojoModelPathValueNode pathFromEntityTypeToUsedValue)

Declare that the given path is read by the bridge at indexing time to route 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.

Parameters:

pathFromEntityTypeToUsedValue - The path from the indexed entity type to the value used by the bridge.

Returns:

this, for method chaining.

Throws:

SearchException - If the given path cannot be applied to the indexed entity type.