org.eclipse.ocl.pivot.internal.scoping

Class EnvironmentView

java.lang.Object

org.eclipse.ocl.pivot.internal.scoping.EnvironmentView

public class EnvironmentView
extends java.lang.Object

An EnvironmentView provides a selective view of the environment visible at some CS node. The selection corresponds to an Environment lookup method as defined by the OCL specification computed in accordance with the the Inherited Attributes. The selective view is normally for just the single name required by the lookUp, but may be for all names when a Completion Assist is required. The EnvironmentView is computed on demand, rather than cached, since only small parts of the overall environment are needed and caches may not remain valid for long given the rapid recreation of CS nodes that occurs while editing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentView.Disambiguator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected EnvironmentFactoryInternal	environmentFactory
protected java.lang.String	name
protected org.eclipse.emf.ecore.EStructuralFeature	reference

Constructor Summary

Constructors

Constructor and Description
EnvironmentView(EnvironmentFactoryInternal environmentFactory, org.eclipse.emf.ecore.EStructuralFeature reference, java.lang.String name) Deprecated. Use ParserContext constructor
EnvironmentView(ParserContext parserContext, org.eclipse.emf.ecore.EStructuralFeature reference, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	accepts(org.eclipse.emf.ecore.EClass eClass)
void	addAllElements(Class asClass, ScopeView scopeView)
void	addAllEnumerationLiterals(Enumeration pivot)
void	addAllOperations(Class type, FeatureFilter featureFilter)
void	addAllPackages(Model root)
void	addAllPackages(Package pkge)
void	addAllParameters(Operation pivot)
void	addAllPrecedences(Library pivot)
void	addAllProperties(Class type, FeatureFilter featureFilter)
void	addAllStates(Type type)
void	addAllTemplateParameters(TemplateableElement pivot)
void	addAllTypes(Package pkge)
static <T> void	addDisambiguator(java.lang.Class<T> targetClass, java.util.Comparator<T> disambiguator)
void	addElement(java.lang.String elementName, Element element)
void	addElement(java.lang.String elementName, java.lang.Object element) Add an element with an elementName to the view
void	addElements(java.lang.Iterable<? extends java.lang.Object> elements)
void	addElements(java.util.Map<java.lang.String,?> elements)
void	addElementsOfScope(Element asElement, ScopeView scopeView)
void	addFilter(ScopeFilter filter)
void	addImportedElement(org.eclipse.emf.common.util.URI baseURI)
void	addLibContents(Class libType, ScopeView scopeView)
void	addNamedElement(Nameable namedElement)
void	addNamedElement(NamedElement namedElement)
void	addNamedElements(java.lang.Iterable<? extends Nameable> namedElements)
void	addRootPackages()
int	computeLookups(Element target, Element child)
int	computeLookups(ScopeView scopeView)
void	computeQualifiedLookups(Element target)
Attribution	getAttribution(org.eclipse.emf.ecore.EObject eObject)
org.eclipse.emf.ecore.EObject	getContent()
static java.lang.Iterable<java.lang.Class<?>>	getDisambiguatorKeys()
static java.util.List<java.util.Comparator<java.lang.Object>>	getDisambiguators(java.lang.Class<?> key)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	getEntries()
EnvironmentFactoryInternal	getEnvironmentFactory()
java.lang.String	getName()
org.eclipse.emf.ecore.EStructuralFeature	getReference()
org.eclipse.emf.ecore.EClassifier	getRequiredType()
int	getSize()
StandardLibraryInternal	getStandardLibrary()
boolean	hasFinalResult() Return true once the EnvironmentView has accumulated sufficient results to satisfy the lookup criterion for which it was created.
boolean	isQualifier()
void	removeFilter(ScopeFilter filter)
int	resolveDuplicates()
void	setIsQualifier(boolean isQualifier)
void	setRequiredType(org.eclipse.emf.ecore.EClassifier requiredType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

environmentFactory

@NonNull
protected final EnvironmentFactoryInternal environmentFactory

reference

@NonNull
protected final org.eclipse.emf.ecore.EStructuralFeature reference

name

@Nullable
protected final java.lang.String name

Constructor Detail

EnvironmentView

public EnvironmentView(@NonNull
                       ParserContext parserContext,
                       @NonNull
                       org.eclipse.emf.ecore.EStructuralFeature reference,
                       @Nullable
                       java.lang.String name)

Since:

1.3

EnvironmentView

@Deprecated
public EnvironmentView(@NonNull
                                    EnvironmentFactoryInternal environmentFactory,
                                    @NonNull
                                    org.eclipse.emf.ecore.EStructuralFeature reference,
                                    @Nullable
                                    java.lang.String name)

Deprecated. Use ParserContext constructor

Method Detail

addDisambiguator

public static <T> void addDisambiguator(java.lang.Class<T> targetClass,
                                        @NonNull
                                        java.util.Comparator<T> disambiguator)

getDisambiguatorKeys

@NonNull
public static java.lang.Iterable<java.lang.Class<?>> getDisambiguatorKeys()

getDisambiguators

@Nullable
public static java.util.List<java.util.Comparator<java.lang.Object>> getDisambiguators(@NonNull
                                                                                                  java.lang.Class<?> key)

accepts

public boolean accepts(org.eclipse.emf.ecore.EClass eClass)

addAllElements

public void addAllElements(Class asClass,
                           @NonNull
                           ScopeView scopeView)

addAllEnumerationLiterals

public void addAllEnumerationLiterals(Enumeration pivot)

addAllOperations

public void addAllOperations(Class type,
                             @Nullable
                             FeatureFilter featureFilter)

addAllPackages

public void addAllPackages(Package pkge)

addAllPackages

public void addAllPackages(@NonNull
                           Model root)

addAllParameters

public void addAllParameters(@NonNull
                             Operation pivot)

addAllPrecedences

public void addAllPrecedences(@NonNull
                              Library pivot)

addAllProperties

public void addAllProperties(Class type,
                             @Nullable
                             FeatureFilter featureFilter)

addAllStates

public void addAllStates(@NonNull
                         Type type)

addAllTemplateParameters

public void addAllTemplateParameters(@NonNull
                                     TemplateableElement pivot)

addAllTypes

public void addAllTypes(Package pkge)

addElement

public void addElement(@Nullable
                       java.lang.String elementName,
                       @Nullable
                       java.lang.Object element)

Add an element with an elementName to the view

Parameters:

elementName - name of element

element - the element

addElement

public void addElement(@Nullable
                       java.lang.String elementName,
                       @Nullable
                       Element element)

addElements

public void addElements(@NonNull
                        java.util.Map<java.lang.String,?> elements)

addElements

public void addElements(@Nullable
                        java.lang.Iterable<? extends java.lang.Object> elements)

addElementsOfScope

public void addElementsOfScope(@Nullable
                               Element asElement,
                               @NonNull
                               ScopeView scopeView)

addFilter

public void addFilter(@NonNull
                      ScopeFilter filter)

addImportedElement

public void addImportedElement(@NonNull
                               org.eclipse.emf.common.util.URI baseURI)

addLibContents

public void addLibContents(Class libType,
                           @NonNull
                           ScopeView scopeView)

addNamedElement

public void addNamedElement(Nameable namedElement)

addNamedElement

public void addNamedElement(NamedElement namedElement)

addNamedElements

public void addNamedElements(java.lang.Iterable<? extends Nameable> namedElements)

addRootPackages

public void addRootPackages()

computeLookups

public int computeLookups(@NonNull
                          Element target,
                          @Nullable
                          Element child)

computeLookups

public int computeLookups(@NonNull
                          ScopeView scopeView)

computeQualifiedLookups

public void computeQualifiedLookups(@NonNull
                                    Element target)

getAttribution

@NonNull
public Attribution getAttribution(@NonNull
                                            org.eclipse.emf.ecore.EObject eObject)

Since:

1.3

getContent

@Nullable
public org.eclipse.emf.ecore.EObject getContent()

getEntries

@NonNull
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> getEntries()

getEnvironmentFactory

@NonNull
public EnvironmentFactoryInternal getEnvironmentFactory()

getName

@Nullable
public java.lang.String getName()

getReference

@NonNull
public org.eclipse.emf.ecore.EStructuralFeature getReference()

getRequiredType

@Nullable
public org.eclipse.emf.ecore.EClassifier getRequiredType()

getSize

public int getSize()

getStandardLibrary

@NonNull
public StandardLibraryInternal getStandardLibrary()

hasFinalResult

public boolean hasFinalResult()

Return true once the EnvironmentView has accumulated sufficient results to satisfy the lookup criterion for which it was created. i.e. any result for a non-null name, all results for a null name.

isQualifier

public boolean isQualifier()

removeFilter

public void removeFilter(@NonNull
                         ScopeFilter filter)

resolveDuplicates

public int resolveDuplicates()

setIsQualifier

public void setIsQualifier(boolean isQualifier)

setRequiredType

public void setRequiredType(@Nullable
                            org.eclipse.emf.ecore.EClassifier requiredType)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object