com.jaxio.celerio.spi

Interface RelationSpi

All Known Implementing Classes:

AbstractRelationSpi, JpaIntermediateManyToOneRelation, JpaIntermediateOneToManyRelation, JpaManyToManyRelation, JpaOneToManyRelation, JpaToOneRelation, ValidationRelation

public interface RelationSpi

The RelationSpi interface allows Celerio template developers to plug new Relation helpers. The implementations are loaded by the java's ServiceLoader.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compatibleWith(Relation relation) Whether the SPI is compatible with the passed relation.
void	init(Relation relation) Invoked by Celerio, when this RelationSpi is binded on a Relation instance.
String	velocityVar() The var name under which this RelationSpi is available during template evaluation.

Method Detail

compatibleWith

boolean compatibleWith(Relation relation)

Whether the SPI is compatible with the passed relation.

Returns:

true if this SPI must be binded on the passed relation, false otherwise.

init

void init(Relation relation)

Invoked by Celerio, when this RelationSpi is binded on a Relation instance.

velocityVar

String velocityVar()

The var name under which this RelationSpi is available during template evaluation.
For example if velocityVar() methods returns myextension, the corresponding RelationSpi implementation instance is given by $relation.myextension.