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

Interface PojoOtherEntityIndexingDependencyConfigurationContext

@Incubating
public interface PojoOtherEntityIndexingDependencyConfigurationContext

Method Summary

Modifier and Type	Method	Description
default PojoOtherEntityIndexingDependencyConfigurationContext	use(String pathFromOtherEntityTypeToUsedValue)	Declare that the given path is read by the bridge at index time to populate the indexed document.
PojoOtherEntityIndexingDependencyConfigurationContext	use(PojoModelPathValueNode pathFromBridgedTypeToUsedValue)	Declare that the given path is read by the bridge at index time to populate the indexed document.

Method Detail

use

@Incubating
default PojoOtherEntityIndexingDependencyConfigurationContext use(String pathFromOtherEntityTypeToUsedValue)

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

Parameters:

pathFromOtherEntityTypeToUsedValue - The path from the 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 entity type.

See Also:

use(PojoModelPathValueNode)

use

@Incubating
PojoOtherEntityIndexingDependencyConfigurationContext use(PojoModelPathValueNode pathFromBridgedTypeToUsedValue)

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.

Parameters:

pathFromBridgedTypeToUsedValue - The path from the 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 entity type.