APIdia Launch Partner
Top Description Methods
io.github.spannm.jackcess.expr

public Interface EvalConfig

Known Direct Implementers
io.github.spannm.jackcess.impl.DBEvalContext
Imports
io.github.spannm.jackcess.Database, java.util.Locale, javax.script.Bindings

The EvalConfig allows for customization of the expression evaluation context for a given Database instance.
See Also
expression package docs

Method Summary

Modifier and TypeMethod and Description
public Bindings

Returns:

the currently configured Bindings
getBindings
()

Returns the currently configured Bindings.

public FunctionLookup

Returns:

the currently configured FunctionLookup
getFunctionLookup
()

Returns the currently configured FunctionLookup.

public Locale

Returns:

the currently configured Locale
getLocale
()

Returns the currently configured Locale.

public NumericConfig

Returns:

the currently configured NumericConfig
getNumericConfig
()

Returns the currently configured NumericConfig.

public TemporalConfig

Returns:

the currently configured TemporalConfig
getTemporalConfig
()

Returns the currently configured TemporalConfig.

public void
setBindings(Bindings bindings)

Allows for passing custom information into expression evaluation.

public void
setFunctionLookup(FunctionLookup lookup)

Sets the Function provider to use during expression evaluation.

public void
setLocale(Locale locale)

Sets the Locale for use when evaluating expressions.

public void
setNumericConfig(NumericConfig numeric)

Sets the NumericConfig for use when evaluating expressions.

public void
setTemporalConfig(TemporalConfig temporal)

Sets the TemporalConfig for use when evaluating expressions.

Method Detail

getBindingsback to summary
public Bindings getBindings()

Returns the currently configured Bindings.

Returns:Bindings

the currently configured Bindings

getFunctionLookupback to summary
public FunctionLookup getFunctionLookup()

Returns the currently configured FunctionLookup.

Returns:FunctionLookup

the currently configured FunctionLookup

getLocaleback to summary
public Locale getLocale()

Returns the currently configured Locale.

Returns:Locale

the currently configured Locale

getNumericConfigback to summary
public NumericConfig getNumericConfig()

Returns the currently configured NumericConfig.

Returns:NumericConfig

the currently configured NumericConfig

getTemporalConfigback to summary
public TemporalConfig getTemporalConfig()

Returns the currently configured TemporalConfig.

Returns:TemporalConfig

the currently configured TemporalConfig

setBindingsback to summary
public void setBindings(Bindings bindings)

Allows for passing custom information into expression evaluation. Currently, none of the default implementations make use of the Bindings. However, in the future, customization parameters could potentially be supported via custom Bindings. Additionally, custom Function instances could be passed external information via custom Bindings.

setFunctionLookupback to summary
public void setFunctionLookup(FunctionLookup lookup)

Sets the Function provider to use during expression evaluation. The Functions supported by the default FunctionLookup are documented in io.github.spannm.jackcess.expr. Custom Functions can be implemented and provided to the expression evaluation engine by installing a custom FunctionLookup instance (which would presumably wrap and delegate to the default FunctionLookup instance for any default implementations).

setLocaleback to summary
public void setLocale(Locale locale)

Sets the Locale for use when evaluating expressions. The default locale is Locale#US, so this may need to be modified when interacting with Database instances from other locales.

setNumericConfigback to summary
public void setNumericConfig(NumericConfig numeric)

Sets the NumericConfig for use when evaluating expressions. The default date/time formatting is US based, so this may need to be modified when interacting with Database instances from other locales.

setTemporalConfigback to summary
public void setTemporalConfig(TemporalConfig temporal)

Sets the TemporalConfig for use when evaluating expressions. The default date/time formatting is US based, so this may need to be modified when interacting with Database instances from other locales.