com.whitestein.lsps.lang.exec

Interface Namespace

All Superinterfaces:

HolderFactory

All Known Implementing Classes:

AbstractContextNamespace, ContextNamespace, MockNamespace, MockRecordNamespace, NoBaseContextNamespace, RecordNamespace

public interface Namespace
extends HolderFactory

Interface representing namespace in execution.

Author:

rba

Method Summary

Modifier and Type	Method and Description
void	addNewVariable(String name, Type type, boolean isDefinedInExpression) Adds a new variable.
boolean	canBeInterpretedIn(InterpreterConfiguration configuration) Returns true if interpretation with given configuration can be done on this namespace.
boolean	containsVariable(String name) Returns true if this namespace contains variable of given name.
Namespace	createChildNamespace(String name, Collection<Field> fields, Collection<?> initialValues, InterpreterConfiguration configuration) Creates new child namespace with this namespace as the parent.
InterpreterConfiguration	getConfiguration() Returns interpreter configurartion for this namespace.
Object	getConstantValue(String moduleName, 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.
String	getEvaluationLevel() Return evaluation level.
Object	getExecutionContext()
Type	getFreeType(FreeType type) Returns the value of given free type or null if it does not exist in this context.
HolderFactory	getHolderFactory() Returns an instance of HolderFactory.
Object	getJavaObject() Returns underlying java object if there is some.
Namespace	getLowerLevelNamespace() Returns namespace corresponding to this namespace on lower level.
String	getModelElementId() Returns id of model element that is related to this namespace.
long	getModelId() Returns model id.
long	getModelInstanceId() Returns model instance id.
Collection<String>	getModuleNames() Returns collection of all module names.
Namespace	getModuleNamespace(String name) Returns module namespace by its module name or null if it does not exist.
String	getName() Returns name of this namespace.
Namespace	getNamespaceInLevel(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.
Set<String>	getVariableNames() Returns the names of all the variables.
Type	getVariableType(String name) Returns the type of variable or null if it does not exist.
Object	getVariableValue(String name) Returns value of variable for given name from this namespace.
void	remove() INTERNAL API.
RecordType	resolveRecordType(String type) Resolves record type and returns its type.
Type	resolveType(String type) Resolves type.
void	setFreeType(FreeType type, Type value) Sets value for given free type.
void	setPerformReadOnlyCheck(boolean performReadOnlyCheck) Allows to enable/disable checking assignment to read only variables.
void	setVariableValue(String name, 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, createNonSharedRecord, createRange, createRecord, createRecord, createRecord, createRecord, createReference, createSet

Method Detail

getName

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

getModuleNamespace

Namespace getModuleNamespace(String name)

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

Parameters:

name -

Returns:

imported namespace

getModuleNames

Collection<String> getModuleNames()

Returns collection of all module names.

Returns:

collection of all module names

containsVariable

boolean containsVariable(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

Set<String> getVariableNames()

Returns the names of all the variables.

Returns:

the names of all the variables

getVariableValue

Object getVariableValue(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(String name,
                      Object value)

Sets value of variable for given name from this namespace.

Parameters:

name - variable name

value - new variable value

Throws:

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

getVariableType

Type getVariableType(String name)

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

Parameters:

name - variable name

Returns:

the type of variable

getConstantValue

Object getConstantValue(String moduleName,
                        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

Namespace createChildNamespace(String name,
                               Collection<Field> fields,
                               Collection<?> 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:

NullPointerException - if name or fields is null

IllegalArgumentException - if fields contains null element

setFreeType

void setFreeType(FreeType type,
                 Type value)

Sets value for given free type.

Parameters:

type -

value -

Throws:

NullPointerException - if type or value is null

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:

NullPointerException - if type is null

addNewVariable

void addNewVariable(String name,
                    Type type,
                    boolean isDefinedInExpression)

Adds a new variable.

Parameters:

name -

type -

isDefinedInExpression -

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(String type)

Resolves type.

Parameters:

type -

Returns:

type

Throws:

NullPointerException - if type is null

IllegalArgumentException - if no such type exists

resolveRecordType

RecordType resolveRecordType(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:

NullPointerException - if type is null

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

setPerformReadOnlyCheck

void setPerformReadOnlyCheck(boolean performReadOnlyCheck)

Allows to enable/disable checking assignment to read only variables.

Parameters:

performReadOnlyCheck -

getNamespaceInLevel

Namespace getNamespaceInLevel(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

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

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

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

Object getExecutionContext()

remove

void remove()

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