org.springframework.data.spel.spi

Interface EvaluationContextExtension

public interface EvaluationContextExtension

SPI to allow adding a set of properties and function definitions accessible via the root of an EvaluationContext provided by a ExtensionAwareQueryMethodEvaluationContextProvider.

Since:

1.9

Author:

Thomas Darimont, Oliver Gierke

Method Summary

Modifier and Type	Method and Description
String	getExtensionId() Returns the identifier of the extension.
default Map<String,Function>	getFunctions() Returns the functions exposed by the extension.
default Map<String,Object>	getProperties() Returns the properties exposed by the extension.
default Object	getRootObject() Returns the root object to be exposed by the extension.

Method Detail

getExtensionId

String getExtensionId()

Returns the identifier of the extension. The id can be leveraged by users to fully qualify property lookups and thus overcome ambiguities in case multiple extensions expose properties with the same name.

Returns:

the extension id, must not be null.

getProperties

default Map<String,Object> getProperties()

Returns the properties exposed by the extension.

Returns:

the properties

getFunctions

default Map<String,Function> getFunctions()

Returns the functions exposed by the extension.

Returns:

the functions

getRootObject

@Nullable
default Object getRootObject()

Returns the root object to be exposed by the extension. It's strongly recommended to declare the most concrete type possible as return type of the implementation method. This will allow us to obtain the necessary metadata once and not for every evaluation.

Returns: