com.whitestein.lsps.lang.exec

Interface Namespace

All Superinterfaces:

FreeTypeMapping, HolderFactory

All Known Implementing Classes:

AbstractContextNamespace, AbstractMockNamespace, ContextNamespace, MockNamespace, MockNamespacePart, MockRecordNamespace, NoBaseContextNamespace, RecordNamespace, RecordProxySetNamespace

public interface Namespace
extends HolderFactory, FreeTypeMapping

Interface representing namespace in execution.

Author:

rba

Method Summary

Modifier and Type	Method and Description
default void	addNewVariable(java.lang.String name, Type type, boolean isDefinedInExpression) Adds a new variable.
void	addNewVariable(java.lang.String name, Type type, boolean isDefinedInExpression, boolean readOnly) Adds a new variable.
boolean	canBeInterpretedIn(InterpreterConfiguration configuration) Returns true if interpretation with given configuration can be done on this namespace.
boolean	containsVariable(java.lang.String name) Returns true if this namespace contains variable of given name.
default Namespace	createChildNamespace(java.lang.String name, java.util.List<? extends Field> fields, java.util.List<?> initialValues, InterpreterConfiguration configuration) Creates new child namespace with this namespace as the parent.
Namespace	createChildNamespace(java.lang.String name, java.util.List<? extends Field> fields, java.util.List<?> initialValues, java.util.Map<FreeType,Type> freeTypeMapping, InterpreterConfiguration configuration)
java.util.Set<java.lang.String>	getAllFreeTypeNames() Returns all free type names.
java.lang.Object	getCompiled()
java.lang.Object	getCompiled(java.lang.String moduleName)
InterpreterConfiguration	getConfiguration() Returns interpreter configurartion for this namespace.
java.lang.Object	getConstantValue(java.lang.String moduleName, java.lang.String constantName) Returns the value of the constant with the given name from a (imported) module with a given module name.
long	getContextId() Returns context id.
java.lang.String	getEvaluationLevel() Return evaluation level.
java.lang.Object	getExecutionContext()
Type	getFreeType(FreeType type) Returns the value of given free type or null if it does not exist in this context.
default Type	getFreeTypeMapping(FreeType freeType) Returns the mapping of given free type.
HolderFactory	getHolderFactory() Returns an instance of HolderFactory.
java.lang.Object	getJavaObject() Returns underlying java object if there is some.
Namespace	getLowerLevelNamespace() Returns namespace corresponding to this namespace on lower level.
java.lang.String	getModelElementId() Returns id of model element that is related to this namespace.
long	getModelId() Returns model id.
long	getModelInstanceId() Returns model instance id.
java.util.Collection<java.lang.String>	getModuleNames() Returns collection of all module names.
Namespace	getModuleNamespace(java.lang.String name) Returns module namespace by its module name or null if it does not exist.
java.lang.String	getName() Returns name of this namespace.
Namespace	getNamespaceInLevel(java.lang.String evaluationLevel) Returns namespace in evaluation level.
NamespaceModel	getNamespaceModel() Returns NamespaceModel for this namespace.
Namespace	getParentNamespace() Returns parent namespace or null if this is top namespace.
QID	getPathQID() Returns QID of the context path.
RecordHolder	getThis() Returns object that represents this.
default Namespace	getTopNamespace() Returns the top namespace (i.e.
java.util.Set<java.lang.String>	getVariableNames() Returns the names of all the variables.
Type	getVariableType(java.lang.String name) Returns the type of variable or null if it does not exist.
java.lang.Object	getVariableValue(java.lang.String name) Returns value of variable for given name from this namespace.
void	initializeVariable(java.lang.String name, java.lang.Object value) Sets the initial value of a variable.
boolean	isVariableReadOnly(java.lang.String name) Returns true if the variable with a given name is read-only.
void	remove() INTERNAL API.
default RecordType	resolveRecordType(java.lang.String type) Resolves record type and returns its type.
Type	resolveType(java.lang.String type) Resolves type.
void	setCompiled(java.lang.Object compiled)
void	setVariableValue(java.lang.String name, java.lang.Object value) Sets value of variable for given name from this namespace.

Methods inherited from interface com.whitestein.lsps.lang.HolderFactory

createBinaryHolder, createBinaryHolder, createClosure, createClosure, createClosure, createClosureFromExpression, createExternalRecordProxy, createList, createMap, createMap, createNonSharedRecord, createRange, createRecord, createRecord, createRecord, createRecord, createReference, createSet

Method Detail

getName

java.lang.String getName()

Returns name of this namespace. Name is always not null and does not have to be unique. Multiple namespaces can share same name.

Returns:

name if this namespace

getPathQID

QID getPathQID()

Returns QID of the context path.

Returns:

QID of the context path

getParentNamespace

Namespace getParentNamespace()

Returns parent namespace or null if this is top namespace.

Returns:

parent namespace

getTopNamespace

default Namespace getTopNamespace()

Returns the top namespace (i.e. namespace which has null parent).

Returns:

the top namespace

getModuleNamespace

Namespace getModuleNamespace(java.lang.String name)

Returns module namespace by its module name or null if it does not exist.

Parameters:

name -

Returns:

imported namespace

getModuleNames

java.util.Collection<java.lang.String> getModuleNames()

Returns collection of all module names.

Returns:

collection of all module names

containsVariable

boolean containsVariable(java.lang.String name)

Returns true if this namespace contains variable of given name.

Parameters:

name - variable name

Returns:

true if this namespace contains variable of given name

getVariableNames

java.util.Set<java.lang.String> getVariableNames()

Returns the names of all the variables.

Returns:

the names of all the variables

getVariableValue

java.lang.Object getVariableValue(java.lang.String name)

Returns value of variable for given name from this namespace. Null is returned if this namespace does not contain given variable.

Parameters:

name - variable name

Returns:

variable value

setVariableValue

void setVariableValue(java.lang.String name,
                      java.lang.Object value)

Sets value of variable for given name from this namespace.

Parameters:

name - variable name

value - new variable value

Throws:

java.lang.IllegalArgumentException - if variable for given name does not exist in this namespace or if the value cannot be assigned to the variable because of validation errors

initializeVariable

void initializeVariable(java.lang.String name,
                        java.lang.Object value)

Sets the initial value of a variable. Can be used to initialize read-only variables. If the variable already has a non-null value, an exception is thrown.

Parameters:

name -

value -

Throws:

java.lang.IllegalStateException - if the variable is already initialized

getVariableType

Type getVariableType(java.lang.String name)

Returns the type of variable or null if it does not exist.

Parameters:

name - variable name

Returns:

the type of variable

isVariableReadOnly

boolean isVariableReadOnly(java.lang.String name)

Returns true if the variable with a given name is read-only.

Parameters:

name -

Returns:

true if the variable is read-only

getConstantValue

java.lang.Object getConstantValue(java.lang.String moduleName,
                                  java.lang.String constantName)

Returns the value of the constant with the given name from a (imported) module with a given module name.

Parameters:

moduleName -

constantName -

Returns:

the value of the constant with the given name or null if there is no such a constant

getHolderFactory

HolderFactory getHolderFactory()

Returns an instance of HolderFactory. This can be used to create different runtime objects.

Returns:

an instance of HolderFactory

createChildNamespace

default Namespace createChildNamespace(java.lang.String name,
                                       java.util.List<? extends Field> fields,
                                       java.util.List<?> initialValues,
                                       InterpreterConfiguration configuration)

Creates new child namespace with this namespace as the parent. The namespace contains variables defined by fields.

Parameters:

name - the namespace name

fields -

initialValues -

configuration -

Returns:

new child namespace

Throws:

java.lang.NullPointerException - if name or fields is null

java.lang.IllegalArgumentException - if fields contains null element

createChildNamespace

Namespace createChildNamespace(java.lang.String name,
                               java.util.List<? extends Field> fields,
                               java.util.List<?> initialValues,
                               java.util.Map<FreeType,Type> freeTypeMapping,
                               InterpreterConfiguration configuration)

Parameters:

name -

fields -

initialValues -

freeTypeMapping -

configuration -

Returns:

the created child namespace

getFreeType

Type getFreeType(FreeType type)

Returns the value of given free type or null if it does not exist in this context.

Parameters:

type -

Returns:

the value of given free type

Throws:

java.lang.NullPointerException - if type is null

getAllFreeTypeNames

java.util.Set<java.lang.String> getAllFreeTypeNames()

Returns all free type names.

Returns:

all free type names

getFreeTypeMapping

default Type getFreeTypeMapping(FreeType freeType)

Description copied from interface: FreeTypeMapping

Returns the mapping of given free type.

Specified by:

getFreeTypeMapping in interface FreeTypeMapping

Returns:

the mapping of given free type

addNewVariable

default void addNewVariable(java.lang.String name,
                            Type type,
                            boolean isDefinedInExpression)

Adds a new variable.

Parameters:

name -

type -

isDefinedInExpression -

addNewVariable

void addNewVariable(java.lang.String name,
                    Type type,
                    boolean isDefinedInExpression,
                    boolean readOnly)

Adds a new variable.

Parameters:

name -

type -

isDefinedInExpression -

readOnly -

getConfiguration

InterpreterConfiguration getConfiguration()

Returns interpreter configurartion for this namespace.

Returns:

interpreter configurartion for this namespace

canBeInterpretedIn

boolean canBeInterpretedIn(InterpreterConfiguration configuration)

Returns true if interpretation with given configuration can be done on this namespace.

Parameters:

configuration -

Returns:

true if interpretation with given configuration can be done on this namespace

resolveType

Type resolveType(java.lang.String type)

Resolves type.

Parameters:

type -

Returns:

type

Throws:

java.lang.NullPointerException - if type is null

java.lang.IllegalArgumentException - if no such type exists

resolveRecordType

default RecordType resolveRecordType(java.lang.String type)

Resolves record type and returns its type.

To check if such record exists, call NamespaceModel.findNamedType(QID) as follows:

final boolean recordExists = getNamespaceModel().findNamedType(QID.parse(type)) != null;

Parameters:

type - fully qualified record type, not null.

Returns:

record type, never null.

Throws:

java.lang.NullPointerException - if type is null

java.lang.IllegalArgumentException - if no such type exists or a type is not a record type

getNamespaceInLevel

Namespace getNamespaceInLevel(java.lang.String evaluationLevel)

Returns namespace in evaluation level.

Parameters:

evaluationLevel -

Returns:

namespace in evaluation level

getLowerLevelNamespace

Namespace getLowerLevelNamespace()

Returns namespace corresponding to this namespace on lower level.

Returns:

namespace corresponding to this namespace on lower level

getEvaluationLevel

java.lang.String getEvaluationLevel()

Return evaluation level.

Returns:

evaluation level

getModelId

long getModelId()

Returns model id.

Returns:

model id

getModelInstanceId

long getModelInstanceId()

Returns model instance id.

Returns:

model instance id

getContextId

long getContextId()

Returns context id.

Returns:

context id

getNamespaceModel

NamespaceModel getNamespaceModel()

Returns NamespaceModel for this namespace.

Returns:

NamespaceModel for this namespace

getModelElementId

java.lang.String getModelElementId()

Returns id of model element that is related to this namespace.

Returns:

id of model element

getThis

RecordHolder getThis()

Returns object that represents this.

Returns:

object that represents this.

getJavaObject

java.lang.Object getJavaObject()

Returns underlying java object if there is some. E.g. for pojo based shared records.

Returns:

underlying java object if there is some

getExecutionContext

java.lang.Object getExecutionContext()

remove

void remove()

INTERNAL API. Removes the namespace from its parent and from the model instance.

getCompiled

java.lang.Object getCompiled()

getCompiled

java.lang.Object getCompiled(java.lang.String moduleName)

setCompiled

void setCompiled(java.lang.Object compiled)