Interface TypeBridge
-
- All Superinterfaces:
AutoCloseable
public interface TypeBridge extends AutoCloseable
A bridge between a POJO type and an element of the index schema.The
TypeBridgeinterface is a more powerful version ofValueBridgethat applies to a whole type instead of a single property, and can contribute more than one index field, in particular.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidclose()Close any resource before the bridge is discarded.voidwrite(DocumentElement target, Object bridgedElement, TypeBridgeWriteContext context)Write to fields in the givenDocumentElement, using the givenbridgedElementas input and transforming it as necessary.
-
-
-
Method Detail
-
write
void write(DocumentElement target, Object bridgedElement, TypeBridgeWriteContext context)
Write to fields in the givenDocumentElement, using the givenbridgedElementas input and transforming it as necessary.Writing to the
DocumentElementshould be done usingIndexFieldReferences retrieved when the bridge wasbound.Warning: Reading from
bridgedElementshould be done with care. Any read that was not declared duringbinding(by declaring dependencies usingTypeBindingContext.dependencies()or (advanced use) creating an accessor usingTypeBindingContext.bridgedElement()) may lead to out-of-sync indexes, because Hibernate Search will consider the read property irrelevant to indexing and will not reindex entities when that property changes.- Parameters:
target- TheDocumentElementto write to.bridgedElement- The element this bridge is applied to, from which data should be read.context- A context that can beextendedto a more useful type, giving access to such things as a Hibernate ORM Session (if using the Hibernate ORM mapper).
-
close
default void close()
Close any resource before the bridge is discarded.- Specified by:
closein interfaceAutoCloseable
-
-