org.eclipse.ocl.pivot.utilities

Class AbstractEnvironmentFactory

java.lang.Object

org.eclipse.ocl.pivot.internal.evaluation.AbstractCustomizable

org.eclipse.ocl.pivot.utilities.AbstractEnvironmentFactory

All Implemented Interfaces:

EnvironmentFactoryInternal, EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension, Adaptable, Customizable, EnvironmentFactory, EnvironmentFactory.EnvironmentFactoryExtension, EnvironmentFactory.EnvironmentFactoryExtension2

Direct Known Subclasses:

GlobalEnvironmentFactory, PivotEnvironmentFactory

public abstract class AbstractEnvironmentFactory
extends AbstractCustomizable
implements EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension

Partial implementation of the EnvironmentFactoryInternal interface, useful for subclassing to define the Pivot binding for a metamodel.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.pivot.internal.utilities.EnvironmentFactoryInternal

EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension

Nested classes/interfaces inherited from interface org.eclipse.ocl.pivot.utilities.EnvironmentFactory

EnvironmentFactory.EnvironmentFactoryExtension, EnvironmentFactory.EnvironmentFactoryExtension2

Field Summary

Fields

Modifier and Type	Field and Description
static TracingOption	ENVIRONMENT_FACTORY_ATTACH

Method Summary

Modifier and Type	Method and Description
EnvironmentFactoryAdapter	adapt(Notifier notifier)
void	addExternal2AS(External2AS external2as)
void	addExternalResources(ResourceSet resourceSet) Add all resources in ResourceSet to the externalResourceSet.
void	attach(Object object)
void	configureLoadFirstStrategy() Configure the PackageRegistry associated with the (external) ResourceSet to use a load strategy that uses whichever of the namespace or platform URI is first encountered and which suppresses diagnostics about subsequent use of the other form of URI.
void	configureLoadStrategy(ProjectManager.IResourceLoadStrategy packageLoadStrategy, ProjectManager.IConflictHandler conflictHandler) Configure the PackageRegistry associated with the (external) ResourceSet to use a packageLoadStrategy and conflictHandler when resolving namespace and platform URIs.
ResourceSetImpl	createASResourceSet() Create and initialize the AS ResourceSet used by metamodelManager to contain the AS forms of CS and Ecore/UML resources.
CompleteEnvironmentInternal	createCompleteEnvironment()
EvaluationEnvironment	createEvaluationEnvironment(EvaluationEnvironment parent, NamedElement executableObject) Deprecated. no longer used
EvaluationEnvironment	createEvaluationEnvironment(NamedElement executableObject, ModelManager modelManager) Creates a new evaluation environment to track the values of variables in an OCL expression as it is evaluated.
EvaluationVisitor	createEvaluationVisitor(EvaluationEnvironment evaluationEnvironment) Creates a new evaluation visitor, for the evaluation of OCL expressions.
EvaluationVisitor	createEvaluationVisitor(Object context, ExpressionInOCL expression, ModelManager modelManager) Creates a new evaluation visitor, for the evaluation of an OCL expression on a context using an environment and a modelManager.
ExecutorInternal	createExecutor(ModelManager modelManager) Create an Executor for OCL evaluation.
IdResolver	createIdResolver() Create and initialize the IdResolver used by metamodelManager to convert Ids to Elements.
ImplementationManager	createImplementationManager()
PivotMetamodelManager	createMetamodelManager()
ModelManager	createModelManager(Object object) Creates an extent map for invocation of OclType.allInstances() using the specified object as a context from which to find the scope in which OCL classifier extents are defined.
OCLInternal	createOCL() Creates a new OCL instance attached to this EnvironmentFactory.
ParserContext	createParserContext(EObject context) Deprecated.
TemplateParameterSubstitutionVisitor	createTemplateParameterSubstitutionVisitor(Type selfType, Type selfTypeValue) Create a visitor to resolve TemplateParameter specializations.
void	detach(Object zobject)
void	dispose()
<T> T	getAdapter(Class<T> adapterType) The abstract environment factory implementation is adaptable.
Class	getASClass(String className) Return the pivot model class for className with the Pivot Model.
<T extends Element> T	getASOf(Class<T> pivotClass, EObject eObject)
CompleteEnvironmentInternal	getCompleteEnvironment() Return the CompleteEnvironment that supervises the additional types need for collections specializations and tuples.
CompleteModelInternal	getCompleteModel() Return the CompleteModel that contains all the CompletePackages, which in turn contain all the CompleteClasses that define the merge of individual Packages and Classes.
ICSI2ASMapping	getCSI2ASMapping()
String	getDoSetupName(URI uri)
IdResolver	getIdResolver() Return the IdResolver that performs the resolution of the lightweight usage-independent Ids of types and packages into the full usage-specific equivalents.
PivotMetamodelManager	getMetamodelManager() Return the MetamodelManager used to supervise the normalized Abstract Syntax representations of the metamodels.
ProjectManager	getProjectManager() Return the ProjectMap used to resolve EPackages.
ResourceSet	getResourceSet() Return the external ResourceSet used to hold External Syntax (e.g.
StatusCodes.Severity	getSeverity(Object validationKey) Return the StatusCodes severity with which the validation identified by validationKey is reported.
StandardLibraryInternal	getStandardLibrary() Return the (OCL) Standard Library that provides the build-in language facilities such as the OclAny and Set types.
Technology	getTechnology()
boolean	isDisposed() Return true if this EnvironmentFactory's life cycle has completed.
boolean	isEvaluationTracingEnabled() Queries whether tracing of evaluation is enabled.
EPackage	loadEPackage(EPackage ePackage) Ensure that EPackage has been loaded in the externalResourceSet PackageRegistry.
Element	loadResource(Resource resource, URI uri)
ExpressionInOCL	parseSpecification(LanguageExpression specification) Return the compiled query for a specification resolving a String body into a non-null bodyExpression.
void	resetSeverities()
void	setCSI2ASMapping(ICSI2ASMapping csi2asMapping)
void	setEvaluationTracingEnabled(boolean b) Sets whether tracing of evaluation is enabled.
void	setProject(IProject project) Specify an Eclipse project with respect to which project-specific preferences are resolved.
void	setSafeNavigationValidationSeverity(StatusCodes.Severity severity) Configure safe navigation validation severities.
StatusCodes.Severity	setSeverity(Object validationKey, StatusCodes.Severity severity) Define the StatusCodes severity with which the validation identified by validationKey is reported.

Methods inherited from class org.eclipse.ocl.pivot.internal.evaluation.AbstractCustomizable

clearOptions, getOptions, getValue, isEnabled, putOptions, removeOption, removeOptions, setOption

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.pivot.utilities.Customizable

clearOptions, getOptions, getValue, isEnabled, putOptions, removeOption, removeOptions, setOption

Field Detail

ENVIRONMENT_FACTORY_ATTACH

public static final TracingOption ENVIRONMENT_FACTORY_ATTACH

Since:

1.4

Method Detail

adapt

public EnvironmentFactoryAdapter adapt(Notifier notifier)

Specified by:

adapt in interface EnvironmentFactory

addExternal2AS

public void addExternal2AS(External2AS external2as)

Specified by:

addExternal2AS in interface EnvironmentFactoryInternal

addExternalResources

public void addExternalResources(ResourceSet resourceSet)

Add all resources in ResourceSet to the externalResourceSet.

Specified by:

addExternalResources in interface EnvironmentFactoryInternal

attach

public void attach(Object object)

Specified by:

attach in interface EnvironmentFactoryInternal

configureLoadFirstStrategy

public void configureLoadFirstStrategy()

Description copied from interface: EnvironmentFactoryInternal

Configure the PackageRegistry associated with the (external) ResourceSet to use a load strategy that uses whichever of the namespace or platform URI is first encountered and which suppresses diagnostics about subsequent use of the other form of URI.

Specified by:

configureLoadFirstStrategy in interface EnvironmentFactoryInternal

configureLoadStrategy

public void configureLoadStrategy(ProjectManager.IResourceLoadStrategy packageLoadStrategy,
                                  ProjectManager.IConflictHandler conflictHandler)

Description copied from interface: EnvironmentFactoryInternal

Configure the PackageRegistry associated with the (external) ResourceSet to use a packageLoadStrategy and conflictHandler when resolving namespace and platform URIs.

Specified by:

configureLoadStrategy in interface EnvironmentFactoryInternal

createASResourceSet

public ResourceSetImpl createASResourceSet()

Description copied from interface: EnvironmentFactoryInternal

Create and initialize the AS ResourceSet used by metamodelManager to contain the AS forms of CS and Ecore/UML resources.

Specified by:

createASResourceSet in interface EnvironmentFactoryInternal

createCompleteEnvironment

public CompleteEnvironmentInternal createCompleteEnvironment()

Specified by:

createCompleteEnvironment in interface EnvironmentFactoryInternal

createEvaluationEnvironment

public EvaluationEnvironment createEvaluationEnvironment(NamedElement executableObject,
                                                         ModelManager modelManager)

Description copied from interface: EnvironmentFactory

Creates a new evaluation environment to track the values of variables in an OCL expression as it is evaluated.

Specified by:

createEvaluationEnvironment in interface EnvironmentFactory

Returns:

a new evaluation environment

createEvaluationEnvironment

@Deprecated
public EvaluationEnvironment createEvaluationEnvironment(EvaluationEnvironment parent,
                                                                     NamedElement executableObject)

Deprecated. no longer used

Specified by:

createEvaluationEnvironment in interface EnvironmentFactory

createEvaluationVisitor

public EvaluationVisitor createEvaluationVisitor(Object context,
                                                 ExpressionInOCL expression,
                                                 ModelManager modelManager)

Description copied from interface: EnvironmentFactory

Creates a new evaluation visitor, for the evaluation of an OCL expression on a context using an environment and a modelManager. If environment is null, a root environment is created and used. If context is null and the expression uses self subsequent evaluations will give invalid as the result. If modelManager is null, the context object's ResoutceSet is analyzed to create one.

Specified by:

createEvaluationVisitor in interface EnvironmentFactory

createEvaluationVisitor

public EvaluationVisitor createEvaluationVisitor(EvaluationEnvironment evaluationEnvironment)

Description copied from interface: EnvironmentFactory

Creates a new evaluation visitor, for the evaluation of OCL expressions.

Specified by:

createEvaluationVisitor in interface EnvironmentFactory

Parameters:

evaluationEnvironment - the evaluation environment that the visitor is to use for tracking variables, navigating properties, etc.

Returns:

the new evaluation visitor

createExecutor

public ExecutorInternal createExecutor(ModelManager modelManager)

Description copied from interface: EnvironmentFactory.EnvironmentFactoryExtension

Create an Executor for OCL evaluation. For derived languages, consumers are expected to create the appropriate Executor directly.

Specified by:

createExecutor in interface EnvironmentFactory.EnvironmentFactoryExtension

Since:

1.1

createIdResolver

public IdResolver createIdResolver()

Description copied from interface: EnvironmentFactoryInternal

Create and initialize the IdResolver used by metamodelManager to convert Ids to Elements.

Specified by:

createIdResolver in interface EnvironmentFactoryInternal

createImplementationManager

public ImplementationManager createImplementationManager()

Specified by:

createImplementationManager in interface EnvironmentFactoryInternal

createMetamodelManager

public PivotMetamodelManager createMetamodelManager()

Specified by:

createMetamodelManager in interface EnvironmentFactoryInternal

createModelManager

public ModelManager createModelManager(Object object)

Creates an extent map for invocation of OclType.allInstances() using the specified object as a context from which to find the scope in which OCL classifier extents are defined. This scope may be a resource, resource set, or some metamodel-specific scope. Note that in the case that the object is not an EObject but is, instead, some primitive type, then this may be difficult to determine.

Clients are encouraged to do what they can to optimize this mapping, by lazy initialization of key-value pairs, workspace indices, or whatever means is available. Note that the map will only ever be accessed by key (Map.get(java.lang.Object)); it will never be queried for all entries, all keys, all values, etc. This knowledge could help optimization.

Specified by:

createModelManager in interface EnvironmentFactory

Parameters:

object - a context object in the scope that covers the OCL classifier extents

Returns:

the extent map

createOCL

public OCLInternal createOCL()

Description copied from interface: EnvironmentFactory

Creates a new OCL instance attached to this EnvironmentFactory.

Clients should call OCL.dispose() to detach once they have no further use for the OCL.

Specified by:

createOCL in interface EnvironmentFactoryInternal

Specified by:

createOCL in interface EnvironmentFactory

Returns:

a new OCL instance attached to this EnvironmentFactory

createParserContext

@Deprecated
public ParserContext createParserContext(EObject context)
                                              throws ParserException

Deprecated.

Description copied from interface: EnvironmentFactoryInternal

Create a ParserContext that may be used to parse OCL expressions in the given context, which may be an EClassifier/EOperation/EStructuralFeature or Type/Operation/Property. Returns a ModelContext if no more specfic context can be determined if none can be created.

Specified by:

createParserContext in interface EnvironmentFactoryInternal

Specified by:

createParserContext in interface EnvironmentFactory.EnvironmentFactoryExtension2

Throws:

ParserException

createTemplateParameterSubstitutionVisitor

public TemplateParameterSubstitutionVisitor createTemplateParameterSubstitutionVisitor(Type selfType,
                                                                                       Type selfTypeValue)

Description copied from interface: EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension

Create a visitor to resolve TemplateParameter specializations. The visitor is normally created by the ASResourceFactory override of a relevant ASResource, but in the event that the ASResource is null, this altrernative creation mechanism is available via an EnvironmentFactory override.

Specified by:

createTemplateParameterSubstitutionVisitor in interface EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension

Since:

1.1

detach

public void detach(Object zobject)

Specified by:

detach in interface EnvironmentFactoryInternal

dispose

public void dispose()

Specified by:

dispose in interface EnvironmentFactoryInternal

getASClass

public Class getASClass(String className)

Return the pivot model class for className with the Pivot Model.

Specified by:

getASClass in interface EnvironmentFactory.EnvironmentFactoryExtension2

getASOf

public <T extends Element> T getASOf(Class<T> pivotClass,
                                     EObject eObject)
                              throws ParserException

Specified by:

getASOf in interface EnvironmentFactory.EnvironmentFactoryExtension2

Throws:

ParserException

Since:

1.4

getAdapter

public <T> T getAdapter(Class<T> adapterType)

The abstract environment factory implementation is adaptable. The default implementation adapts to and interface actually implemented by the receiver.

Subclasses may override or extend this implementation.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class AbstractCustomizable

Type Parameters:

T - the requested adapter interface

Parameters:

adapterType - the requested adapter interface

Returns:

an instance of the requested interface, or null if this environment does not adapt to it

getCompleteEnvironment

public CompleteEnvironmentInternal getCompleteEnvironment()

Description copied from interface: EnvironmentFactory

Return the CompleteEnvironment that supervises the additional types need for collections specializations and tuples.

Specified by:

getCompleteEnvironment in interface EnvironmentFactoryInternal

Specified by:

getCompleteEnvironment in interface EnvironmentFactory

getCompleteModel

public CompleteModelInternal getCompleteModel()

Description copied from interface: EnvironmentFactory

Return the CompleteModel that contains all the CompletePackages, which in turn contain all the CompleteClasses that define the merge of individual Packages and Classes.

Specified by:

getCompleteModel in interface EnvironmentFactoryInternal

Specified by:

getCompleteModel in interface EnvironmentFactory

getCSI2ASMapping

public ICSI2ASMapping getCSI2ASMapping()

Specified by:

getCSI2ASMapping in interface EnvironmentFactoryInternal

getDoSetupName

public String getDoSetupName(URI uri)

Specified by:

getDoSetupName in interface EnvironmentFactoryInternal

getIdResolver

public IdResolver getIdResolver()

Description copied from interface: EnvironmentFactory

Return the IdResolver that performs the resolution of the lightweight usage-independent Ids of types and packages into the full usage-specific equivalents.

Specified by:

getIdResolver in interface EnvironmentFactory

getMetamodelManager

public PivotMetamodelManager getMetamodelManager()

Description copied from interface: EnvironmentFactory

Return the MetamodelManager used to supervise the normalized Abstract Syntax representations of the metamodels.

Specified by:

getMetamodelManager in interface EnvironmentFactoryInternal

Specified by:

getMetamodelManager in interface EnvironmentFactory

getProjectManager

public ProjectManager getProjectManager()

Return the ProjectMap used to resolve EPackages.

Specified by:

getProjectManager in interface EnvironmentFactory

getResourceSet

public ResourceSet getResourceSet()

Description copied from interface: EnvironmentFactory

Return the external ResourceSet used to hold External Syntax (e.g. Ecore or UML) and/or Concrete Syntax model representations. The internal ResoutrceSet used for Abstract Syntax resources is available by invoking getMetamodelmanager().getASResourceSet().

Specified by:

getResourceSet in interface EnvironmentFactory

getSeverity

public StatusCodes.Severity getSeverity(Object validationKey)

Description copied from interface: EnvironmentFactory

Return the StatusCodes severity with which the validation identified by validationKey is reported. StatusCodes.OK severity suppresses the validation altogether. StatusCodes.Warning is returned for any null or unknown key.

Specified by:

getSeverity in interface EnvironmentFactory

getStandardLibrary

public StandardLibraryInternal getStandardLibrary()

Description copied from interface: EnvironmentFactory

Return the (OCL) Standard Library that provides the build-in language facilities such as the OclAny and Set types.

Specified by:

getStandardLibrary in interface EnvironmentFactoryInternal

Specified by:

getStandardLibrary in interface EnvironmentFactory

getTechnology

public Technology getTechnology()

Specified by:

getTechnology in interface EnvironmentFactoryInternal

isDisposed

public boolean isDisposed()

Description copied from interface: EnvironmentFactory.EnvironmentFactoryExtension2

Return true if this EnvironmentFactory's life cycle has completed.

Specified by:

isDisposed in interface EnvironmentFactory.EnvironmentFactoryExtension2

isEvaluationTracingEnabled

public boolean isEvaluationTracingEnabled()

Queries whether tracing of evaluation is enabled. Tracing logs the progress of evaluation to the console, which may be of use in diagnosing problems.

In an Eclipse environment, tracing is also enabled by turning on the org.eclipse.ocl/debug/evaluation debug option.

Specified by:

isEvaluationTracingEnabled in interface EnvironmentFactory.EnvironmentFactoryExtension

Returns:

whether evaluation tracing is enabled

Since:

1.1

See Also:

setEvaluationTracingEnabled(boolean)

loadEPackage

public EPackage loadEPackage(EPackage ePackage)

Description copied from interface: EnvironmentFactoryInternal

Ensure that EPackage has been loaded in the externalResourceSet PackageRegistry.

Specified by:

loadEPackage in interface EnvironmentFactoryInternal

loadResource

public Element loadResource(Resource resource,
                            URI uri)
                     throws ParserException

Specified by:

loadResource in interface EnvironmentFactoryInternal

Throws:

ParserException

parseSpecification

public ExpressionInOCL parseSpecification(LanguageExpression specification)
                                   throws ParserException

Return the compiled query for a specification resolving a String body into a non-null bodyExpression. Throws a ParserException if conversion fails.

Specified by:

parseSpecification in interface EnvironmentFactory.EnvironmentFactoryExtension2

Throws:

ParserException

Since:

1.4

resetSeverities

public void resetSeverities()

setCSI2ASMapping

public void setCSI2ASMapping(ICSI2ASMapping csi2asMapping)

Specified by:

setCSI2ASMapping in interface EnvironmentFactoryInternal

setEvaluationTracingEnabled

public void setEvaluationTracingEnabled(boolean b)

Sets whether tracing of evaluation is enabled. Tracing logs the progress of parsing to the console, which may be of use in diagnosing problems.

In an Eclipse environment, tracing is also enabled by turning on the org.eclipse.ocl/debug/evaluation debug option.

param b whether evaluation tracing is enabled

Specified by:

setEvaluationTracingEnabled in interface EnvironmentFactoryInternal

See Also:

isEvaluationTracingEnabled()

setProject

public void setProject(IProject project)

Description copied from interface: EnvironmentFactoryInternal

Specify an Eclipse project with respect to which project-specific preferences are resolved.

Specified by:

setProject in interface EnvironmentFactoryInternal

setSafeNavigationValidationSeverity

public void setSafeNavigationValidationSeverity(StatusCodes.Severity severity)

Configure safe navigation validation severities.

Specified by:

setSafeNavigationValidationSeverity in interface EnvironmentFactoryInternal

setSeverity

public StatusCodes.Severity setSeverity(Object validationKey,
                                        StatusCodes.Severity severity)

Description copied from interface: EnvironmentFactory

Define the StatusCodes severity with which the validation identified by validationKey is reported. StatusCodes.OK severity suppresses the validation altogether. Returns any previous setting.

Specified by:

setSeverity in interface EnvironmentFactory