org.eclipse.ocl.pivot.internal.utilities

Interface EnvironmentFactoryInternal

All Superinterfaces:

Adaptable, Customizable, EnvironmentFactory

All Known Subinterfaces:

EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension

All Known Implementing Classes:

AbstractEnvironmentFactory, GlobalEnvironmentFactory, PivotEnvironmentFactory

public interface EnvironmentFactoryInternal
extends EnvironmentFactory

A factory for creating OCL parser and evaluation artefacts. Clients of the OCL parser that wish to use OCL with their metamodels can provide the parser a factory that creates the suitable environments. The environment provides mappings from the client's metamodel to the UML concepts required by the parser (corresponding to the generic type parameters, below). Many of these mappings are optional (e.g., state machines, signals, and association classes aren't supported by all metamodels).

This interface is not intended to be implemented to be implemented "directly" by providers of metamodel bindings. It is highly recommended to extend the AbstractEnvironmentFactory class, instead.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EnvironmentFactoryInternal.EnvironmentFactoryInternalExtension

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

EnvironmentFactory.EnvironmentFactoryExtension, EnvironmentFactory.EnvironmentFactoryExtension2

Method Summary

Modifier and Type	Method and Description
void	addExternal2AS(External2AS external2as)
void	addExternalResources(ResourceSet externalResourceSet) 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()
FlowAnalysis	createFlowAnalysis(OCLExpression contextExpression)
IdResolver	createIdResolver() Create and initialize the IdResolver used by metamodelManager to convert Ids to Elements.
ImplementationManager	createImplementationManager()
PivotMetamodelManager	createMetamodelManager()
OCLInternal	createOCL() Creates a new OCL instance attached to this EnvironmentFactory.
ParserContext	createParserContext(EObject context) Deprecated.
void	detach(Object object)
void	dispose()
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)
PivotMetamodelManager	getMetamodelManager() Return the MetamodelManager used to supervise the normalized Abstract Syntax representations of the metamodels.
StandardLibraryInternal	getStandardLibrary() Return the (OCL) Standard Library that provides the build-in language facilities such as the OclAny and Set types.
Technology	getTechnology()
EPackage	loadEPackage(EPackage ePackage) Ensure that EPackage has been loaded in the externalResourceSet PackageRegistry.
Element	loadResource(Resource resource, URI uri)
void	setCSI2ASMapping(ICSI2ASMapping csi2asMapping)
void	setEvaluationTracingEnabled(boolean b)
void	setProject(IProject project) Specify an Eclipse project with respect to which project-specific preferences are resolved.
void	setSafeNavigationValidationSeverity(StatusCodes.Severity severity)

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

adapt, createEvaluationEnvironment, createEvaluationEnvironment, createEvaluationVisitor, createEvaluationVisitor, createModelManager, getIdResolver, getProjectManager, getResourceSet, getSeverity, setSeverity

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

getAdapter

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

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

Method Detail

addExternal2AS

void addExternal2AS(External2AS external2as)

addExternalResources

void addExternalResources(ResourceSet externalResourceSet)

Add all resources in ResourceSet to the externalResourceSet.

attach

void attach(Object object)

configureLoadFirstStrategy

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.

configureLoadStrategy

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.

createASResourceSet

ResourceSetImpl createASResourceSet()

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

createFlowAnalysis

FlowAnalysis createFlowAnalysis(OCLExpression contextExpression)

Since:

1.7

createCompleteEnvironment

CompleteEnvironmentInternal createCompleteEnvironment()

createIdResolver

IdResolver createIdResolver()

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

createImplementationManager

ImplementationManager createImplementationManager()

createMetamodelManager

PivotMetamodelManager createMetamodelManager()

createOCL

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 EnvironmentFactory

Returns:

a new OCL instance attached to this EnvironmentFactory

createParserContext

@Deprecated
ParserContext createParserContext(EObject context)
                                       throws ParserException

Deprecated.

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.

Throws:

ParserException

detach

void detach(Object object)

dispose

void dispose()

getCSI2ASMapping

ICSI2ASMapping getCSI2ASMapping()

getCompleteEnvironment

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 EnvironmentFactory

getCompleteModel

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 EnvironmentFactory

getDoSetupName

String getDoSetupName(URI uri)

getMetamodelManager

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 EnvironmentFactory

getStandardLibrary

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 EnvironmentFactory

getTechnology

Technology getTechnology()

loadEPackage

EPackage loadEPackage(EPackage ePackage)

Ensure that EPackage has been loaded in the externalResourceSet PackageRegistry.

loadResource

Element loadResource(Resource resource,
                     URI uri)
              throws ParserException

Throws:

ParserException

setCSI2ASMapping

void setCSI2ASMapping(ICSI2ASMapping csi2asMapping)

setEvaluationTracingEnabled

void setEvaluationTracingEnabled(boolean b)

setProject

void setProject(IProject project)

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

setSafeNavigationValidationSeverity

void setSafeNavigationValidationSeverity(StatusCodes.Severity severity)