org.eclipse.xtext.linking.lazy

Class LazyLinkingResource

java.lang.Object

org.eclipse.emf.common.notify.impl.BasicNotifierImpl

org.eclipse.emf.common.notify.impl.NotifierImpl

org.eclipse.emf.ecore.resource.impl.ResourceImpl

org.eclipse.xtext.resource.XtextResource

org.eclipse.xtext.linking.lazy.LazyLinkingResource

All Implemented Interfaces:

org.eclipse.emf.common.notify.Notifier, org.eclipse.emf.ecore.resource.Resource, org.eclipse.emf.ecore.resource.Resource.Internal

Direct Known Subclasses:

StorageAwareResource

public class LazyLinkingResource
extends XtextResource

Author:

Sven Efftinge - Initial contribution and API, Holger Schill

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LazyLinkingResource.CyclicLinkingException
protected static class	LazyLinkingResource.DiagnosticMessageContext

Nested classes/interfaces inherited from class org.eclipse.emf.ecore.resource.impl.ResourceImpl

org.eclipse.emf.ecore.resource.impl.ResourceImpl.ContentsEList<E extends Object & org.eclipse.emf.ecore.EObject>, org.eclipse.emf.ecore.resource.impl.ResourceImpl.ModificationTrackingAdapter

Nested classes/interfaces inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl

org.eclipse.emf.common.notify.impl.BasicNotifierImpl.EAdapterList<E extends Object & org.eclipse.emf.common.notify.Adapter>, org.eclipse.emf.common.notify.impl.BasicNotifierImpl.EObservableAdapterList

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.resource.Resource

org.eclipse.emf.ecore.resource.Resource.Diagnostic, org.eclipse.emf.ecore.resource.Resource.Factory, org.eclipse.emf.ecore.resource.Resource.Internal, org.eclipse.emf.ecore.resource.Resource.IOWrappedException

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedHashSet<Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>>	resolving
static String	UNRESOLVEABLE_PROXIES_KEY The cache key for a Set of uri fragments that cannot be resolved.

Fields inherited from class org.eclipse.xtext.resource.XtextResource

isUpdating, operationCanceledManager, OPTION_ENCODING, OPTION_FORMAT, OPTION_RESOLVE_ALL, OPTION_SERIALIZATION_OPTIONS

Fields inherited from class org.eclipse.emf.ecore.resource.impl.ResourceImpl

contents, defaultDeleteOptions, defaultLoadOptions, defaultSaveOptions, errors, intrinsicIDToEObjectMap, isLoaded, isLoading, isModified, modificationTrackingAdapter, resourceSet, timeStamp, unloadingContents, uri, warnings

Fields inherited from class org.eclipse.emf.common.notify.impl.NotifierImpl

eAdapters, EDELIVER, eFlags, ELAST_NOTIFIER_FLAG

Fields inherited from interface org.eclipse.emf.ecore.resource.Resource

OPTION_CIPHER, OPTION_LINE_DELIMITER, OPTION_LINE_DELIMITER_UNSPECIFIED, OPTION_SAVE_ONLY_IF_CHANGED, OPTION_SAVE_ONLY_IF_CHANGED_FILE_BUFFER, OPTION_SAVE_ONLY_IF_CHANGED_MEMORY_BUFFER, OPTION_ZIP, RESOURCE__CONTENTS, RESOURCE__ERRORS, RESOURCE__IS_LOADED, RESOURCE__IS_MODIFIED, RESOURCE__IS_TRACKING_MODIFICATION, RESOURCE__RESOURCE_SET, RESOURCE__TIME_STAMP, RESOURCE__URI, RESOURCE__WARNINGS

Constructor Summary

Constructors

Constructor and Description
LazyLinkingResource()

Method Summary

Methods

Modifier and Type	Method and Description
int	addLazyProxyInformation(org.eclipse.emf.ecore.EObject obj, org.eclipse.emf.ecore.EReference ref, INode node)
void	clearLazyProxyInformation()
protected void	createAndAddDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
protected void	createAndAddDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple, IllegalNodeException ex)
protected org.eclipse.emf.ecore.resource.Resource.Diagnostic	createDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple, DiagnosticMessage message)
protected DiagnosticMessage	createDiagnosticMessage(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
protected ILinkingDiagnosticMessageProvider.ILinkingDiagnosticContext	createDiagnosticMessageContext(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
protected void	doLinking()
protected void	doLoad(InputStream inputStream, Map<?,?> options)
protected void	doResolveLazyCrossReference(org.eclipse.emf.ecore.InternalEObject source, org.eclipse.emf.ecore.EStructuralFeature crossRef) Ensures that all the lazy proxy values that are referenced by crossRef are replaced by non-lazy proxies or resolved instances.
protected List<org.eclipse.emf.ecore.resource.Resource.Diagnostic>	getDiagnosticList(DiagnosticMessage message)
ILinkingDiagnosticMessageProvider	getDiagnosticMessageProvider()
LazyURIEncoder	getEncoder()
org.eclipse.emf.ecore.EObject	getEObject(String uriFragment)
protected org.eclipse.emf.ecore.EObject	getEObject(String uriFragment, Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>	getLazyProxyInformation(int idx)
LinkingHelper	getLinkingHelper()
ILinkingService	getLinkingService()
protected String	getReferences(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple, LinkedHashSet<Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>> resolving2)
protected Set<String>	getUnresolvableURIFragments()
protected org.eclipse.emf.ecore.EObject	handleCyclicResolution(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
boolean	hasLazyProxyInformation(int idx)
boolean	isEagerLinking()
protected boolean	isPotentialLazyCrossReference(org.eclipse.emf.ecore.EStructuralFeature feature) Return true if the given feature may hold a proxy that has to be resolved.
protected boolean	isUnresolveableProxyCacheable(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
void	markUnresolvable(org.eclipse.emf.ecore.EObject referenced) Marks the given proxy as unresolvable.
protected void	removeDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>	removeLazyProxyInformation(int idx)
protected void	resolveLazyCrossReference(org.eclipse.emf.ecore.InternalEObject source, org.eclipse.emf.ecore.EStructuralFeature crossRef) If the given crossRef may hold lazy linking proxies, they are attempted to be resolved.
void	resolveLazyCrossReferences(CancelIndicator mon) resolves any lazy cross references in this resource, adding Issues for unresolvable elements to this resource.
void	setDiagnosticMessageProvider(ILinkingDiagnosticMessageProvider diagnosticMessageProvider)
void	setEagerLinking(boolean eagerLinking)
void	setEncoder(LazyURIEncoder encoder)
void	setLinkingHelper(LinkingHelper linkingHelper)
void	setLinkingService(ILinkingService linkingService)

Methods inherited from class org.eclipse.xtext.resource.XtextResource

addSyntaxDiagnostic, addSyntaxErrors, basicGetEObject, clearErrorsAndWarnings, clearInternalState, createReader, doSave, doUnload, getCache, getConcreteSyntaxValidator, getEncoding, getFragmentProvider, getLanguageName, getLinker, getModificationStamp, getParser, getParseResult, getResourceServiceProvider, getSerializer, getUnloader, getURIFragment, isValidationDisabled, reattachModificationTracker, relink, reparse, setCache, setEncodingFromOptions, setFragmentProvider, setInjectedParser, setLanguageName, setLinker, setModificationStamp, setParser, setParseResult, setResourceServiceProvider, setSerializer, setUnloader, setValidationDisabled, unload, update, updateInternalState, updateInternalState, validateConcreteSyntax

Methods inherited from class org.eclipse.emf.ecore.resource.impl.ResourceImpl

addModificationTrackingAdapters, attached, attachedHelper, basicSetResourceSet, createModificationTrackingAdapter, delete, detached, detachedHelper, getAllContents, getAllProperContents, getAllProperContents, getContents, getDefaultURIConverter, getEObject, getEObjectByID, getEObjectForURIFragmentRootSegment, getErrors, getIntrinsicIDToEObjectMap, getResourceSet, getTimeStamp, getURI, getURIConverter, getURIFragmentRootSegment, getWarnings, handleLoadResponse, handleSaveResponse, isAttachedDetachedHelperRequired, isContentZipEntry, isLoaded, isLoading, isModified, isTrackingModification, load, load, mergeMaps, newContentZipEntry, removeModificationTrackingAdapters, save, save, saveOnlyIfChangedWithFileBuffer, saveOnlyIfChangedWithMemoryBuffer, setIntrinsicIDToEObjectMap, setLoaded, setModified, setTimeStamp, setTrackingModification, setURI, toKeyString, toString, unload, unloaded, useZip

Methods inherited from class org.eclipse.emf.common.notify.impl.NotifierImpl

eAdapters, eBasicAdapters, eDeliver, eSetDeliver

Methods inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl

eBasicAdapterArray, eBasicHasAdapters, eNotificationRequired, eNotify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Field Detail

UNRESOLVEABLE_PROXIES_KEY

public static final String UNRESOLVEABLE_PROXIES_KEY

The cache key for a Set of uri fragments that cannot be resolved.

Since:

2.4

See Also:

Constant Field Values

resolving

protected LinkedHashSet<Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>> resolving

Since:

2.4

Constructor Detail

LazyLinkingResource

public LazyLinkingResource()

Method Detail

doLoad

protected void doLoad(InputStream inputStream,
          Map<?,?> options)
               throws IOException

Overrides:

doLoad in class XtextResource

Throws:

IOException

doLinking

protected void doLinking()

Overrides:

doLinking in class XtextResource

resolveLazyCrossReferences

public void resolveLazyCrossReferences(CancelIndicator mon)

resolves any lazy cross references in this resource, adding Issues for unresolvable elements to this resource. This resource might still contain resolvable proxies after this method has been called.

Parameters:

mon - a CancelIndicator can be used to stop the resolution.

resolveLazyCrossReference

protected void resolveLazyCrossReference(org.eclipse.emf.ecore.InternalEObject source,
                             org.eclipse.emf.ecore.EStructuralFeature crossRef)

If the given crossRef may hold lazy linking proxies, they are attempted to be resolved.

Since:

2.4

See Also:

isPotentialLazyCrossReference(EStructuralFeature), doResolveLazyCrossReference(InternalEObject, EStructuralFeature)

doResolveLazyCrossReference

protected void doResolveLazyCrossReference(org.eclipse.emf.ecore.InternalEObject source,
                               org.eclipse.emf.ecore.EStructuralFeature crossRef)

Ensures that all the lazy proxy values that are referenced by crossRef are replaced by non-lazy proxies or resolved instances.

Since:

2.4

isPotentialLazyCrossReference

protected boolean isPotentialLazyCrossReference(org.eclipse.emf.ecore.EStructuralFeature feature)

Return true if the given feature may hold a proxy that has to be resolved. This is supposed to be an internal hook which allows to resolve proxies even in cases where EMF prohibits proxies, e.g. in case of opposite references.

Since:

2.4

getEObject

public org.eclipse.emf.ecore.EObject getEObject(String uriFragment)

Specified by:

getEObject in interface org.eclipse.emf.ecore.resource.Resource

Overrides:

getEObject in class XtextResource

getEObject

protected org.eclipse.emf.ecore.EObject getEObject(String uriFragment,
                                       Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
                                            throws AssertionError

Throws:

AssertionError

Since:

2.4

isUnresolveableProxyCacheable

protected boolean isUnresolveableProxyCacheable(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)

Since:

2.1

handleCyclicResolution

protected org.eclipse.emf.ecore.EObject handleCyclicResolution(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)
                                                        throws AssertionError

Throws:

AssertionError

getReferences

protected String getReferences(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple,
                   LinkedHashSet<Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode>> resolving2)

createAndAddDiagnostic

protected void createAndAddDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)

createAndAddDiagnostic

protected void createAndAddDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple,
                          IllegalNodeException ex)

Since:

2.3

removeDiagnostic

protected void removeDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)

createDiagnostic

protected org.eclipse.emf.ecore.resource.Resource.Diagnostic createDiagnostic(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple,
                                                                  DiagnosticMessage message)

getDiagnosticList

protected List<org.eclipse.emf.ecore.resource.Resource.Diagnostic> getDiagnosticList(DiagnosticMessage message)
                                                                              throws AssertionError

Throws:

AssertionError

createDiagnosticMessage

protected DiagnosticMessage createDiagnosticMessage(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)

createDiagnosticMessageContext

protected ILinkingDiagnosticMessageProvider.ILinkingDiagnosticContext createDiagnosticMessageContext(Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> triple)

setLinkingService

public void setLinkingService(ILinkingService linkingService)

getLinkingService

public ILinkingService getLinkingService()

setEncoder

public void setEncoder(LazyURIEncoder encoder)

getEncoder

public LazyURIEncoder getEncoder()

setEagerLinking

public void setEagerLinking(boolean eagerLinking)

isEagerLinking

public boolean isEagerLinking()

getDiagnosticMessageProvider

public ILinkingDiagnosticMessageProvider getDiagnosticMessageProvider()

setDiagnosticMessageProvider

public void setDiagnosticMessageProvider(ILinkingDiagnosticMessageProvider diagnosticMessageProvider)

getLinkingHelper

public LinkingHelper getLinkingHelper()

setLinkingHelper

public void setLinkingHelper(LinkingHelper linkingHelper)

markUnresolvable

public void markUnresolvable(org.eclipse.emf.ecore.EObject referenced)

Marks the given proxy as unresolvable. Further attempts to resolve it by means of getEObject(String) will yield null.

Since:

2.4

getUnresolvableURIFragments

protected Set<String> getUnresolvableURIFragments()

Since:

2.4

addLazyProxyInformation

public int addLazyProxyInformation(org.eclipse.emf.ecore.EObject obj,
                          org.eclipse.emf.ecore.EReference ref,
                          INode node)

Since:

2.7

hasLazyProxyInformation

public boolean hasLazyProxyInformation(int idx)

Since:

2.7

getLazyProxyInformation

public Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> getLazyProxyInformation(int idx)

Since:

2.7

removeLazyProxyInformation

public Triple<org.eclipse.emf.ecore.EObject,org.eclipse.emf.ecore.EReference,INode> removeLazyProxyInformation(int idx)

Since:

2.7

clearLazyProxyInformation

public void clearLazyProxyInformation()

Since:

2.7