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

public Interface Expression

Known Direct Implementers
io.github.spannm.jackcess.impl.BaseEvalContext.RawExpr, io.github.spannm.jackcess.impl.expr.Expressionator.BaseExprWrapper
Imports
java.util.Collection
An Expression is an executable handle to an Access expression. While the expression framework is implemented separately from the core database functionality, most usage of Expressions will happen indirectly within the context of normal database operations. Thus, most users will not ever directly interact with an Expression instance. That said, Expressions may be executed independently of a Database instance if desired.

Method Summary

Modifier and TypeMethod and Description
public void
collectIdentifiers(Collection<Identifier> identifiers)

Adds any Identifiers from this expression to the given collection.

public Object

Returns:

the result of the expression evaluation
eval(EvalContext
the context within which to evaluate the expression
ctx)

Evaluates the expression and returns the result.

public boolean

Returns:

true if this is a constant expression. A constant expression will always return the same result when invoked and has no side effect.
isConstant()

Returns true if this is a constant expression.

public String

Returns:

a parsed and re-formated version of the expression. This may look slightly different than the original, raw string, although it should be an equivalent expression.
toCleanString(LocaleContext ctx)

Returns a parsed and re-formated version of the expression.

public String

Returns:

a detailed string which indicates how the expression was interpreted by the expression evaluation engine.
toDebugString(LocaleContext ctx)

Returns a detailed string which indicates how the expression was interpreted by the expression evaluation engine.

public String

Returns:

the original, unparsed expression string. This is the same as the value which will be returned by Object#toString.
toRawString()

Returns the original, unparsed expression string.

Method Detail

collectIdentifiersback to summary
public void collectIdentifiers(Collection<Identifier> identifiers)

Adds any Identifiers from this expression to the given collection.

evalback to summary
public Object eval(EvalContext ctx)

Evaluates the expression and returns the result.

Parameters
ctx:EvalContext

the context within which to evaluate the expression

Returns:Object

the result of the expression evaluation

isConstantback to summary
public boolean isConstant()

Returns true if this is a constant expression. A constant expression will always return the same result when invoked and has no side effect.

Returns:boolean

true if this is a constant expression. A constant expression will always return the same result when invoked and has no side effect.

toCleanStringback to summary
public String toCleanString(LocaleContext ctx)

Returns a parsed and re-formated version of the expression. This may look slightly different than the original, raw string, although it should be an equivalent expression.

Returns:String

a parsed and re-formated version of the expression. This may look slightly different than the original, raw string, although it should be an equivalent expression.

toDebugStringback to summary
public String toDebugString(LocaleContext ctx)

Returns a detailed string which indicates how the expression was interpreted by the expression evaluation engine.

Returns:String

a detailed string which indicates how the expression was interpreted by the expression evaluation engine.

toRawStringback to summary
public String toRawString()

Returns the original, unparsed expression string. This is the same as the value which will be returned by Object#toString.

Returns:String

the original, unparsed expression string. This is the same as the value which will be returned by Object#toString.