org.rvpf.processor.engine.rpn

Class RPNEngine

Object

Proxied.Abstract

AbstractEngine

RPNEngine

All Implemented Interfaces:

Engine, Proxied

Direct Known Subclasses:

SelectorEngine

public class RPNEngine
extends AbstractEngine

RPN engine.

Implements an RPN (Reverse Polish Notation) computing engine accepting a Forth-like syntax.

The operations available to the transform programs are supported by the modules supplied to this engine by the '' parameter.

See Also:

RPNTransform, Compiler

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LOOP_LIMIT Default loop limit.

Fields inherited from class AbstractEngine

DEFAULT_BEHAVIOR_PARAM

Fields inherited from interface Engine

BINDING_PARAM, ENGINE_EXECUTOR_PARAM, LOOP_LIMIT_PARAM, MACRO_PARAM, MODULE_PARAM, NAME_PARAM, PASSWORD_PARAM, SECURITY_PARAM, USER_PARAM, WORD_PARAM

Constructor Summary

Constructors

Constructor and Description
RPNEngine()

Method Summary

Modifier and Type	Method and Description
Program	compile(String source, Optional<Map<String,MacroDef>> macroDefs, Optional<Map<String,Program>> wordDefs, Logger logger) Compile a Program from a source String.
Transform	createTransform(TransformEntity proxyEntity) Creates a transform object.
protected Optional<ClassDef>	defaultBehavior() Returns the engine specific default behavior.
Optional<BehaviorEntity>	getDefaultBehavior(PointRelation relation) Gets the default (primary) behavior.
Optional<Map<String,MacroDef>>	getMacroDefs(ProxyEntity proxyEntity) Gets the macro instruction definitions.
Optional<Map<String,Program>>	getWordDefs(ProxyEntity proxyEntity, Optional<Map<String,MacroDef>> macroDefs) Gets the additional word definitions.
void	register(Operations module) Registers an Operations module.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.

Methods inherited from class AbstractEngine

close, getDefaultBehavior

Methods inherited from class Proxied.Abstract

getMetadata, getName, getParams, getProxyEntity, getThisLogger, tearDown

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Proxied

getName, getParams, getProxyEntity, tearDown

Field Detail

DEFAULT_LOOP_LIMIT

public static final int DEFAULT_LOOP_LIMIT

Default loop limit.

See Also:

Constant Field Values

Constructor Detail

RPNEngine

public RPNEngine()

Method Detail

compile

@Nullable
 @CheckReturnValue
public final Program compile(@Nonnull
                                                            String source,
                                                            @Nonnull
                                                            Optional<Map<String,MacroDef>> macroDefs,
                                                            @Nonnull
                                                            Optional<Map<String,Program>> wordDefs,
                                                            @Nonnull
                                                            Logger logger)

Compile a Program from a source String.

Parameters:

source - The source code.

macroDefs - The optional macro instruction definitions.

wordDefs - Optional additional word definitions.

logger - The Logger.

Returns:

The Transform Program (null on failure).

createTransform

public Transform createTransform(TransformEntity proxyEntity)

Creates a transform object.

Parameters:

proxyEntity - The proxy (transform entity) for the transform.

Returns:

The transform (null on failure).

getDefaultBehavior

public Optional<BehaviorEntity> getDefaultBehavior(PointRelation relation)

Gets the default (primary) behavior.

On self-reference (when the input point is the same as the result point), the default behavior becomes Retriggers unless the "SelectSyncPosition" is specified.

Specified by:

getDefaultBehavior in interface Engine

Overrides:

getDefaultBehavior in class AbstractEngine

Parameters:

relation - The relation needing a primary behavior.

Returns:

The optional default behavior.

getMacroDefs

@Nonnull
 @CheckReturnValue
public final Optional<Map<String,MacroDef>> getMacroDefs(@Nonnull
                                                                                       ProxyEntity proxyEntity)
                                                                                throws Compiler.CompileException

Gets the macro instruction definitions.

On name collision, the definitions of the transform will override those of the engine.

Parameters:

proxyEntity - The proxy (transform entity) for the transform.

Returns:

The optional macro defs.

Throws:

Compiler.CompileException - On macro compilation exception.

getWordDefs

@Nonnull
 @CheckReturnValue
public final Optional<Map<String,Program>> getWordDefs(@Nonnull
                                                                                     ProxyEntity proxyEntity,
                                                                                     @Nonnull
                                                                                     Optional<Map<String,MacroDef>> macroDefs)
                                                                              throws Compiler.CompileException

Gets the additional word definitions.

On name collision, the definitions of the transform will override those of the engine.

Parameters:

proxyEntity - The proxy (transform entity) for the transform.

macroDefs - The optional macro instruction definitions.

Returns:

The optional word definitions.

Throws:

Compiler.CompileException - On word compilation exception.

register

public final void register(@Nonnull
                           Operations module)
                    throws Operation.OverloadException

Registers an Operations module.

Parameters:

module - The Operations module.

Throws:

Operation.OverloadException - From Operations set up.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class AbstractEngine

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

defaultBehavior

protected Optional<ClassDef> defaultBehavior()

Returns the engine specific default behavior.

Overrides:

defaultBehavior in class AbstractEngine

Returns:

The optional default behavior class def.