de.espirit.firstspirit.access.template

Interface Evaluator

All Known Subinterfaces:

GenerationContext

public interface Evaluator

Since:

4.0.17

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSLOADER_VARIABLE Variable name for classloader instance.
static String	GLOBAL_VARIABLE
static String	MATH_CONTEXT_VARIABLE

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(Object instance, String attributeName)
Context	getContext()
Object	getDefaultExpression()
Locale	getLocale()
String	getLocaleKey() A locale key, default value is getLocale().getLanguage().toUpperCase()}.
Writer	getOut()
String	getStack()
Printable	getTemplate(String type, String name, Map<String,Object> params)
String	getTopStackElement() The currently evaluated stack element as string - for debugging.
Object	getVariableValue(String variableName)
void	include(String type, Object toInclude, Map<String,Object> params)
Object	invokeMethod(Object instance, String methodName, List<Object> args)
boolean	isDebugging()
void	logDebug(String message)
void	logError(int line, int col, String message)
void	logError(int line, int col, String message, Throwable t)
void	logError(String message)
void	logError(String message, Throwable throwable)
void	logInfo(String message)
void	logWarning(String message)
TemplateDocument	parse(Reader source)
TemplateDocument	parse(String source)
Context	popContext()
void	print(Object value) Print an object instance to the output.
void	print(Printable template)
void	pushContext(Context context) Set a new top context.
Context	pushContext(String name) Will push a new context.
Context	pushContext(String name, Object target) Will push a new context and set the target object as #this.
Context	pushContext(String name, String info) Will push a new context and an info text on the stack
Object	resolveReference(List<Object> params, Map<String,Object> namedParams)
void	setDefaultExpression(Object value)
void	setErrorOut(PrintWriter out)
void	setErrorOut(Writer out) Shortcut for setErrorOut(new PrintWriter(out)).
void	setLocale(Locale value)
void	setLocaleKey(String value)
void	setMaxStackSize(int value)
void	setOut(Writer out)
void	setVariableValue(String variableName, Object value)

Field Detail

MATH_CONTEXT_VARIABLE

static final String MATH_CONTEXT_VARIABLE

Since:

4.1.16

See Also:

Constant Field Values

GLOBAL_VARIABLE

static final String GLOBAL_VARIABLE

Since:

4.1.16

See Also:

Constant Field Values

CLASSLOADER_VARIABLE

static final String CLASSLOADER_VARIABLE

Variable name for classloader instance.

Since:

4.2.211

See Also:

Constant Field Values

Method Detail

getVariableValue

Object getVariableValue(String variableName)

Since:

4.0.17

setVariableValue

void setVariableValue(String variableName,
                    Object value)

Since:

4.0.17

resolveReference

Object resolveReference(List<Object> params,
                      Map<String,Object> namedParams)
                        throws Exception

Throws:

Exception

Since:

4.0.17

include

void include(String type,
           Object toInclude,
           Map<String,Object> params)
             throws IOException

Throws:

IOException

Since:

4.0.17

getAttribute

Object getAttribute(Object instance,
                  String attributeName)
                    throws Exception

Throws:

Exception

Since:

4.0.17

invokeMethod

Object invokeMethod(Object instance,
                  String methodName,
                  List<Object> args)
                    throws Exception

Throws:

Exception

Since:

4.0.17

print

void print(Object value)
           throws IOException

Print an object instance to the output.

Parameters:

value - object

Throws:

IOException

Since:

4.0.17

getContext

Context getContext()

Since:

4.0.17

setLocale

void setLocale(Locale value)

Since:

4.2

getLocale

Locale getLocale()

Since:

4.0.17

getLocaleKey

String getLocaleKey()

A locale key, default value is getLocale().getLanguage().toUpperCase()}.

Since:

4.0.17

See Also:

setLocaleKey(String)

setLocaleKey

void setLocaleKey(String value)

Since:

4.2

See Also:

getLocaleKey()

logError

void logError(String message)

Since:

4.0.17

logError

void logError(String message,
            Throwable throwable)

Since:

4.0.17

logError

void logError(int line,
            int col,
            String message)

Since:

4.0.17

logError

void logError(int line,
            int col,
            String message,
            Throwable t)

Since:

4.0.17

logWarning

void logWarning(String message)

Since:

4.0.17

logInfo

void logInfo(String message)

Since:

4.0.17

logDebug

void logDebug(String message)

Since:

4.0.17

pushContext

Context pushContext(String name,
                  String info)

Will push a new context and an info text on the stack

Parameters:

name - the name of the new context

info - the text wich is put on the context stack

Returns:

the new top context

Since:

4.0.17

See Also:

pushContext(Context)

pushContext

Context pushContext(String name)

Will push a new context. See pushContext(Context) for further informations.

Parameters:

name - the name of the new context

Returns:

the new top context

Since:

4.0.17

See Also:

pushContext(Context)

pushContext

Context pushContext(String name,
                  Object target)

Will push a new context and set the target object as #this.

Parameters:

name - The name of the new context.

target - The target object the context operates on.

Returns:

The new top context.

Since:

5.0.100

See Also:

pushContext(String)

pushContext

void pushContext(Context context)

Set a new top context. The implementation will call Context.setParentContext(Context) on the provided context object.
Always use this in a try .. finally block:

 evaluator.pushContext(myContext)
  try {
      ...
  } finally {
      evaluator.popContext();
  }
 

Parameters:

context - the new top context, null is not allowed

Since:

4.0.17

See Also:

popContext()

popContext

Context popContext()

Returns:

the actual top context

Since:

4.0.17

See Also:

pushContext(Context)

getOut

Writer getOut()

Since:

4.0.17

setOut

void setOut(Writer out)

Since:

4.0.17

setErrorOut

void setErrorOut(Writer out)

Shortcut for setErrorOut(new PrintWriter(out)).

Since:

4.0.17

setErrorOut

void setErrorOut(PrintWriter out)

Since:

4.0.17

print

void print(Printable template)
           throws IOException

Throws:

IOException

Since:

4.0.17

getTemplate

Printable getTemplate(String type,
                    String name,
                    Map<String,Object> params)
                      throws IOException

Throws:

IOException

Since:

4.0.18

getStack

String getStack()

Since:

4.0.17

getTopStackElement

String getTopStackElement()

The currently evaluated stack element as string - for debugging.

Since:

5.0.204

setDefaultExpression

void setDefaultExpression(Object value)

Since:

4.0.17

getDefaultExpression

Object getDefaultExpression()

Since:

4.0.17

setMaxStackSize

void setMaxStackSize(int value)

Since:

4.0.17

parse

TemplateDocument parse(String source)

Since:

4.0.17

parse

TemplateDocument parse(Reader source)
                       throws IOException

Throws:

IOException

Since:

4.0.17

isDebugging

boolean isDebugging()

Since:

4.0.17