com.whitestein.lsps.lang.module

Interface NamespaceModel

All Known Subinterfaces:

Module, ModulePart

All Known Implementing Classes:

AbstractNamespace, BasicModule, BasicModulePart, ClassNamespaceModel

public interface NamespaceModel

This interface specifies methods necessary for namespaces. Unlike "DefinitionsHolder" it focuses of namespace functionality.

Each model contains one global model namespace, and local namespaces for model elements (goals, plans). Also the model may include other models (libraries), which have their own namespaces.

Author:

pna, vbu

Method Summary

Modifier and Type	Method and Description
void	addReferencedOperation(ReferencedOperation refOper) Adds referenced operation so that it can be referenced for expressions compiled to java.
void	addSignature(FunctionSignature signature) Registers a function signature in this namespace.
void	addVariable(String name, Type type) Registers a public variable in this namespace.
void	addVariable(String name, Type type, boolean isPrivate) Registers a variable in this namespace.
void	addVariable(String name, Type type, boolean isPrivate, boolean isReadOnly) Registers a variable in this namespace.
void	addVariable(VariableInfo variable) Registers the given variable in this namespace.
NamedType	findNamedType(QID qid) Find a named type.
Collection<Module>	getAllImportedModules() Returns this module and all imported modules along with their imported modules recursively.
String	getAlternativeName() Returns alternative name.
Constructor<?>	getCompiled() Returns constructor of class that was generated by compilation to java for this namespace model.
Collection<ConstantInfo>	getConstants(QID name) Returns a list of constants for the given fully qualified name.
Collection<SignatureMapping>	getExtensionMethods(Type type) Returns a collection of extension methods for a given type.
Collection<SignatureMapping>	getExtensionMethods(Type type, String methodName) Returns a collection of extension methods for a given type and name.
Module	getImportedModuleByName(String moduleName) Returns a reachable imported module by its module name or null if no such module exists.
Collection<Module>	getImportedModules() Returns imported modules.
Collection<FunctionSignature>	getLocalSignaturesForName(String name) Returns the local function signatures for given name.
Module	getModule() Returns the enclosing module.
String	getName() Returns the name of defined type, which is unique in the module.
NamespaceModel	getParent() Returns the parent namespace or null.
ReferencedOperation	getReferencedOperation(String id) Returns operation for the id.
Collection<FunctionSignature>	getSignatures() Returns function signatures defined in this namespace.
Collection<SignatureMapping>	getSignatures(String namePattern, List<? extends Type> args, Type returnType, Map<String,String> metadataPattern) Returns a collection of function signatures for the given parameters.
Collection<SignatureMapping>	getSignaturesForName(QID name) Returns a collection of function signatures for the given name.
Collection<SignatureMapping>	getSignaturesForName(QID name, ClosureType type) Returns a collection of function signatures for the given name, argument count and expected signature closure type.
Collection<SignatureMapping>	getSignaturesForNamedArgs(QID name, Map<String,Type> args, Type returnType) Returns a collection of function signatures for the given name, arguments names and types and a return type.
ClassType	getStaticType() Returns type for this namespace used for static methods.
ClassType	getThisType() Returns type for this namespace.
NamedType	getTypeForName(String typeName) Returns registered named type corresponding to given name.
VariableInfo	getVariable(String name) Returns a local variable for the given name.
VariableInfo	getVariable(String name, boolean includePrivate) Returns a local variable info for the given name.
boolean	getVariablePrivacy(String name) Returns a local variable privacy for the given name.
Collection<VariableInfo>	getVariables() Returns a collection of all variables in this namespace.
Collection<VariableInfo>	getVariables(QID name) Returns a list of variables for the given fully qualified name.
Collection<ConstantInfo>	getVisibleConstants() Returns a collection of all visible constants.
Collection<NamedType>	getVisibleNamedTypes() Returns a collection of all visible named types (records, enumerations etc.).
Collection<RecordType>	getVisibleRecordTypes() Returns a collection of all visible defined record types.
Collection<FunctionSignature>	getVisibleSignatures() Returns a collection of all visible function signatures.
Collection<VariableInfo>	getVisibleVariables() Returns a collection of all visible variables.
boolean	isModule() Returns true if this is a module.
void	setAlternativeName(String name) Sets alternative name.
void	setCompiled(Constructor<?> constructor) Sets constructor of class that was generated by compilation to java for this namespace model.
boolean	validateIdentifier(String identifierName) Returns true if given identifier name is valid.

Method Detail

getName

String getName()

Returns the name of defined type, which is unique in the module.

Returns:

string containing name of this type

getAlternativeName

String getAlternativeName()

Returns alternative name. If the model is imported and alternative name is not null the namespace model is registered in imports also under this name.

Returns:

alternative name

setAlternativeName

void setAlternativeName(String name)

Sets alternative name. If the model is imported and alternative name is not null the namespace model is registered in imports also under this name.

Parameters:

name -

addSignature

void addSignature(FunctionSignature signature)

Registers a function signature in this namespace.

Parameters:

signature - function signature to be registered in this namespace

addVariable

void addVariable(String name,
                 Type type)

Registers a public variable in this namespace.

Parameters:

name - string containing the name of the variable

type - type of the variable

addVariable

void addVariable(String name,
                 Type type,
                 boolean isPrivate)

Registers a variable in this namespace.

Parameters:

name - string containing the name of the variable

type - type of the variable

isPrivate - true if the variable is private, false if it is public

addVariable

void addVariable(String name,
                 Type type,
                 boolean isPrivate,
                 boolean isReadOnly)

Registers a variable in this namespace.

Parameters:

name - string containing the name of the variable

type - type of the variable

isPrivate - true if the variable is private, false if it is public

isReadOnly - true if the variable is read-only, false otherwise

addVariable

void addVariable(VariableInfo variable)

Registers the given variable in this namespace.

Parameters:

variable -

getVariables

Collection<VariableInfo> getVariables()

Returns a collection of all variables in this namespace.

Returns:

a collection of all variables in this namespace

getVisibleVariables

Collection<VariableInfo> getVisibleVariables()

Returns a collection of all visible variables. Both variable visibility and shadowing is taken into account.

Returns:

a collection of all visible variables

getVisibleConstants

Collection<ConstantInfo> getVisibleConstants()

Returns a collection of all visible constants.

Returns:

a collection of all visible constants

validateIdentifier

boolean validateIdentifier(String identifierName)

Returns true if given identifier name is valid.

Parameters:

identifierName -

Returns:

true if given identifier name is valid

getTypeForName

NamedType getTypeForName(String typeName)

Returns registered named type corresponding to given name.

Parameters:

typeName -

Returns:

registered type with given name

getVisibleRecordTypes

Collection<RecordType> getVisibleRecordTypes()

Returns a collection of all visible defined record types.

Returns:

a collection of all visible defined record types

getVisibleNamedTypes

Collection<NamedType> getVisibleNamedTypes()

Returns a collection of all visible named types (records, enumerations etc.).

Returns:

a collection of all visible named types

getVariable

VariableInfo getVariable(String name)

Returns a local variable for the given name.

Parameters:

name -

Returns:

a local variable or null

getVariablePrivacy

boolean getVariablePrivacy(String name)

Returns a local variable privacy for the given name. This method is used to determine whether "this.NAME" is private.

Parameters:

name -

Returns:

true if variable is private

getVariable

VariableInfo getVariable(String name,
                         boolean includePrivate)

Returns a local variable info for the given name. This method is used to determine what "this.NAME" means.

Parameters:

name -

includePrivate - true if also private variable can be returned, false if only public

Returns:

a local variable with given name

getVariables

Collection<VariableInfo> getVariables(QID name)

Returns a list of variables for the given fully qualified name.

Parameters:

name -

Returns:

a list of variables for the fully qualified name

getConstants

Collection<ConstantInfo> getConstants(QID name)

Returns a list of constants for the given fully qualified name.

Parameters:

name -

Returns:

a list of constants for the fully qualified name

getSignatures

Collection<FunctionSignature> getSignatures()

Returns function signatures defined in this namespace.

Returns:

collection of function signatures

getVisibleSignatures

Collection<FunctionSignature> getVisibleSignatures()

Returns a collection of all visible function signatures.

Returns:

a collection of all visible function signatures

getLocalSignaturesForName

Collection<FunctionSignature> getLocalSignaturesForName(String name)

Returns the local function signatures for given name.

Parameters:

name -

Returns:

the local function signatures for given name

getSignaturesForName

Collection<SignatureMapping> getSignaturesForName(QID name)

Returns a collection of function signatures for the given name.

Parameters:

name -

Returns:

a collection of signature mappings

getSignaturesForName

Collection<SignatureMapping> getSignaturesForName(QID name,
                                                  ClosureType type)

Returns a collection of function signatures for the given name, argument count and expected signature closure type.

Parameters:

name -

type -

Returns:

a collection of signature mappings

getSignaturesForNamedArgs

Collection<SignatureMapping> getSignaturesForNamedArgs(QID name,
                                                       Map<String,Type> args,
                                                       Type returnType)

Returns a collection of function signatures for the given name, arguments names and types and a return type.

Parameters:

name -

args -

returnType -

Returns:

a collection of signature mappings

getSignatures

Collection<SignatureMapping> getSignatures(String namePattern,
                                           List<? extends Type> args,
                                           Type returnType,
                                           Map<String,String> metadataPattern)

Returns a collection of function signatures for the given parameters.

Parameters:

namePattern - regular expression

args -

returnType -

metadataPattern - map with required metadata, values are regular expressions.

Returns:

a collection of signature mappings

getExtensionMethods

Collection<SignatureMapping> getExtensionMethods(Type type,
                                                 String methodName)

Returns a collection of extension methods for a given type and name.

Parameters:

type -

methodName -

Returns:

a collection of signature mappings

getExtensionMethods

Collection<SignatureMapping> getExtensionMethods(Type type)

Returns a collection of extension methods for a given type.

Parameters:

type -

Returns:

a collection of signature mappings

getParent

NamespaceModel getParent()

Returns the parent namespace or null.

Returns:

the parent namespace or null

getImportedModules

Collection<Module> getImportedModules()

Returns imported modules.

Returns:

collection of imported modules

getImportedModuleByName

Module getImportedModuleByName(String moduleName)

Returns a reachable imported module by its module name or null if no such module exists. Includes also this module.

Parameters:

moduleName -

Returns:

the imported module by its module name

getAllImportedModules

Collection<Module> getAllImportedModules()

Returns this module and all imported modules along with their imported modules recursively. Each module is present only once in the result.

Returns:

all imported modules

getModule

Module getModule()

Returns the enclosing module.

Returns:

the enclosing module

isModule

boolean isModule()

Returns true if this is a module.

Returns:

true if this is a module

getThisType

ClassType getThisType()

Returns type for this namespace.

Returns:

type for this namespace

getStaticType

ClassType getStaticType()

Returns type for this namespace used for static methods.

Returns:

type for this namespace

addReferencedOperation

void addReferencedOperation(ReferencedOperation refOper)

Adds referenced operation so that it can be referenced for expressions compiled to java.

Parameters:

refOper -

getReferencedOperation

ReferencedOperation getReferencedOperation(String id)

Returns operation for the id.

Parameters:

id -

Returns:

operation

findNamedType

NamedType findNamedType(QID qid)
                 throws AmbiguousTypeException

Find a named type.

Parameters:

qid - the type name, not null.

Returns:

a record or enum type or null if not found

Throws:

AmbiguousTypeException

getCompiled

Constructor<?> getCompiled()

Returns constructor of class that was generated by compilation to java for this namespace model. Constructor has one parameter of type Namespace

Returns:

constructor of class that was generated by compilation to java for this namespace model

setCompiled

void setCompiled(Constructor<?> constructor)

Sets constructor of class that was generated by compilation to java for this namespace model. Constructor has one parameter of type Namespace

Parameters:

constructor -