org.eclipse.sphinx.emf.resource

Class ExtendedResourceAdapter

java.lang.Object

org.eclipse.emf.common.notify.impl.AdapterImpl

org.eclipse.sphinx.emf.resource.ExtendedResourceAdapter

All Implemented Interfaces:

org.eclipse.emf.common.notify.Adapter, org.eclipse.emf.common.notify.Adapter.Internal, ExtendedResource

public class ExtendedResourceAdapter
extends org.eclipse.emf.common.notify.impl.AdapterImpl
implements ExtendedResource

Adapter-based implementation of ExtendedResource.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.common.notify.Adapter

org.eclipse.emf.common.notify.Adapter.Internal

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Object,java.lang.Object>	problemHandlingOptions The map of options that are used to to control the handling of problems encountered while the resource has been loaded or saved.

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

target

Fields inherited from interface org.eclipse.sphinx.emf.resource.ExtendedResource

COLUMN_NUMBER_KEY_NAME, LINE_NUMBER_KEY_NAME, OPTION_ENABLE_SCHEMA_VALIDATION, OPTION_MAX_PROBLEM_MARKER_COUNT, OPTION_MAX_PROBLEM_MARKER_COUNT_DEFAULT, OPTION_MAX_PROBLEM_MARKER_COUNT_UNLIMITED, OPTION_PROBLEM_MARKER_FACTORY, OPTION_PROGRESS_MONITOR, OPTION_RECORD_LINE_AND_COLUMN_NUMBERS, OPTION_RESOURCE_VERSION_DESCRIPTOR, OPTION_SCHEMA_LOCATION_CATALOG, OPTION_TARGET_METAMODEL_DESCRIPTOR_ID, OPTION_UNLOAD_MEMORY_OPTIMIZED, OPTION_USE_CONTEXT_AWARE_PROXY_URIS, OPTION_XML_VALIDITY_PROBLEM_FORMAT_STRING, OPTION_XML_VALIDITY_PROBLEM_FORMAT_STRING_DEFAULT, OPTION_XML_VALIDITY_PROBLEM_SEVERITY, OPTION_XML_WELLFORMEDNESS_PROBLEM_FORMAT_STRING, OPTION_XML_WELLFORMEDNESS_PROBLEM_FORMAT_STRING_DEFAULT, URI_FRAGMENT_SEPARATOR, URI_QUERY_FIELD_PATTERN, URI_QUERY_FIELD_PATTERN_KEY_GROUP_IDX, URI_QUERY_FIELD_PATTERN_VALUE_GROUP_IDX, URI_QUERY_FIELD_SEPARATOR, URI_QUERY_KEY_VALUE_SEPARATOR, URI_QUERY_SEPARATOR, URI_SCHEME_SEPARATOR, URI_SEGMENT_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ExtendedResourceAdapter()

Method Summary

Modifier and Type	Method and Description
void	augmentToContextAwareProxy(org.eclipse.emf.ecore.EObject proxy) Augments given proxy to a context-aware proxy by adding key/value pairs that contain the target metamodel descriptor and a context URI to the query string of the proxy URI.
org.eclipse.emf.common.util.URI	createURI(java.lang.String uriLiteral, org.eclipse.emf.ecore.EClass eClass) Creates a URI from given uriLiteral that refers to an instance of given object type.
java.util.Map<java.lang.Object,java.lang.Object>	getDefaultLoadOptions() Returns the map of options that, in addition to the overriding options specified during load, are used to to control load behavior.
java.util.Map<java.lang.Object,java.lang.Object>	getDefaultSaveOptions() Returns the map of options that, in addition to the overriding options specified during save, are used to to control save behavior.
org.eclipse.emf.common.util.URI	getHREF(org.eclipse.emf.ecore.EObject eObject) Returns a URI representing an HREF to given EObject stored in underlying Resource.
protected org.eclipse.emf.common.util.URI	getOldURI(org.eclipse.emf.ecore.EObject oldOwner, org.eclipse.emf.ecore.EStructuralFeature oldFeature, org.eclipse.emf.ecore.EObject eObject, boolean resolve)
java.util.Map<java.lang.Object,java.lang.Object>	getProblemHandlingOptions() Returns the map of options that are used to control the handling of problems encountered while the resource has been loaded or saved.
org.eclipse.emf.common.util.URI	getURI(org.eclipse.emf.ecore.EObject eObject) Returns the URI representing given object.
org.eclipse.emf.common.util.URI	getURI(org.eclipse.emf.ecore.EObject eObject, boolean resolve) Returns the URI representing given object.
org.eclipse.emf.common.util.URI	getURI(org.eclipse.emf.ecore.EObject oldOwner, org.eclipse.emf.ecore.EStructuralFeature oldFeature, org.eclipse.emf.ecore.EObject eObject) Returns the URI representing given object.
org.eclipse.emf.common.util.URI	getURI(org.eclipse.emf.ecore.EObject oldOwner, org.eclipse.emf.ecore.EStructuralFeature oldFeature, org.eclipse.emf.ecore.EObject eObject, boolean resolve) Returns the URI representing given object.
protected org.eclipse.emf.common.util.URI	getURI(org.eclipse.emf.common.util.URI resourceURI, java.lang.String eObjectURIFragment)
protected org.eclipse.emf.common.util.URI	getURI(org.eclipse.emf.common.util.URI resourceURI, java.lang.String eObjectURIFragment, boolean resolve)
boolean	isAdapterForType(java.lang.Object type)
boolean	isFullyLoaded() Indicates if the underlying resource has been fully loaded.
protected boolean	isUseContextAwareProxyURIs()
java.lang.String	nomalizeURIFragment(java.lang.String uriFragment) Returns the normalized form of the given URI fragment.
protected org.eclipse.emf.common.util.URI	resolveURI(org.eclipse.emf.common.util.URI uri)
void	setTarget(org.eclipse.emf.common.notify.Notifier newTarget)
org.eclipse.emf.common.util.URI	trimProxyContextInfo(org.eclipse.emf.common.util.URI proxyURI) If given proxy URI contains proxy context-related key/value pairs on its query string, returns the URI formed by removing those key/value pairs or removing the query string entirely in case that no other key/value pairs exist; returns given proxy URI unchanged, otherwise.
void	unloaded(org.eclipse.emf.ecore.EObject eObject) Improved implementation of org.eclipse.emf.ecore.resource.impl.ResourceImpl#unloaded(InternalEObject) enabling memory-optimized unloading of resources and proxy creation with custom URI formats during regular unload.
org.eclipse.emf.common.util.Diagnostic	validateURI(java.lang.String uri) Determines whether or not the given URI string represents a valid URI.

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

getTarget, notifyChanged, unsetTarget

Methods inherited from class java.lang.Object

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

Field Detail

problemHandlingOptions

protected java.util.Map<java.lang.Object,java.lang.Object> problemHandlingOptions

The map of options that are used to to control the handling of problems encountered while the resource has been loaded or saved.

Constructor Detail

ExtendedResourceAdapter

public ExtendedResourceAdapter()

Method Detail

getDefaultLoadOptions

public java.util.Map<java.lang.Object,java.lang.Object> getDefaultLoadOptions()

Description copied from interface: ExtendedResource

Returns the map of options that, in addition to the overriding options specified during load, are used to to control load behavior.

Specified by:

getDefaultLoadOptions in interface ExtendedResource

getDefaultSaveOptions

public java.util.Map<java.lang.Object,java.lang.Object> getDefaultSaveOptions()

Description copied from interface: ExtendedResource

Returns the map of options that, in addition to the overriding options specified during save, are used to to control save behavior.

Specified by:

getDefaultSaveOptions in interface ExtendedResource

getProblemHandlingOptions

public java.util.Map<java.lang.Object,java.lang.Object> getProblemHandlingOptions()

Description copied from interface: ExtendedResource

Returns the map of options that are used to control the handling of problems encountered while the resource has been loaded or saved.

Specified by:

getProblemHandlingOptions in interface ExtendedResource

isUseContextAwareProxyURIs

protected boolean isUseContextAwareProxyURIs()

isFullyLoaded

public boolean isFullyLoaded()

Description copied from interface: ExtendedResource

Indicates if the underlying resource has been fully loaded. By default, this is the case when Resource.isLoaded() returns true.

Custom ExtendedResource implementations may override this method and adapt its behavior to take additional aspects into account, e.g., the completion state of asynchronously performed post load operations or communication processes running in the background.

Specified by:

isFullyLoaded in interface ExtendedResource

Returns:

true if the underlying resource has been fully loaded, false otherwise.

unloaded

public void unloaded(org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ExtendedResource

Improved implementation of org.eclipse.emf.ecore.resource.impl.ResourceImpl#unloaded(InternalEObject) enabling memory-optimized unloading of resources and proxy creation with custom URI formats during regular unload.

Specified by:

unloaded in interface ExtendedResource

See Also:

ExtendedResource.OPTION_UNLOAD_MEMORY_OPTIMIZED, #getURI(InternalEObject)

getURI

public org.eclipse.emf.common.util.URI getURI(org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ExtendedResource

Returns the URI representing given object.

Specified by:

getURI in interface ExtendedResource

Parameters:

eObject - The object to be handled.

Returns:

The URI representing the provided object.

getURI

public org.eclipse.emf.common.util.URI getURI(org.eclipse.emf.ecore.EObject eObject,
                                              boolean resolve)

Description copied from interface: ExtendedResource

Returns the URI representing given object. The resulting URI can optionally be resolved against the URI of the resource which contains the object in question.

Specified by:

getURI in interface ExtendedResource

Parameters:

eObject - The object to be handled.

resolve - Indicates whether the object's URI should be resolved against the URI of the resource which contains the provided model object. This is useful is cases where the native model object URI evaluates in some sort of fragment-based URI which does not contain any information about the resource that contains the model object (e.g., hb:/#//MyComponent/MyParameterValue). By setting resolve to true, such fragment-based URIs will be automatically expanded to a URI that starts with the URI of the model object's resource and is followed by the fragment of the model object's native URI (e.g., platform:/resource/MyProject/MyResource/#//MyComponent/MyParameterValue).

Returns:

The URI representing the provided object.

getURI

public org.eclipse.emf.common.util.URI getURI(org.eclipse.emf.ecore.EObject oldOwner,
                                              org.eclipse.emf.ecore.EStructuralFeature oldFeature,
                                              org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ExtendedResource

Returns the URI representing given object. If the object is removed (i.e., not contained in any resource) its URI is determined by appending the URI fragment segments obtained from the removed object and its potential direct and indirect removed containers to the base URI obtained from the provided old owner and old feature. If the object is still contained in a resource its URI is computed as usual and the old owner and old feature are ignored.

Specified by:

getURI in interface ExtendedResource

Parameters:

oldOwner - The owner object that is assumed to having contained the given object before it was removed.

oldFeature - The feature through which the old owner did contain the given object before it was removed.

eObject - The object to be handled.

Returns:

The URI representing the provided object.

getURI

public org.eclipse.emf.common.util.URI getURI(org.eclipse.emf.ecore.EObject oldOwner,
                                              org.eclipse.emf.ecore.EStructuralFeature oldFeature,
                                              org.eclipse.emf.ecore.EObject eObject,
                                              boolean resolve)

Description copied from interface: ExtendedResource

Returns the URI representing given object. If the object is removed (i.e., not contained in any resource) its URI is determined by appending the URI fragment segments obtained from the removed object and its potential direct and indirect removed containers to the base URI obtained from the provided old owner and old feature. If the object is still contained in a resource its URI is computed as usual and the old owner and old feature are ignored. In both cases, the resulting URI can optionally be resolved against the URI of the resource which does or did contain the object in question.

Specified by:

getURI in interface ExtendedResource

Parameters:

oldOwner - The owner object that is assumed to having contained the given object before it was removed.

oldFeature - The feature through which the old owner did contain the given object before it was removed.

eObject - The object to be handled.

resolve - Indicates whether the object's URI should be resolved against the URI of the resource which contains the provided model object. This is useful is cases where the native model object URI evaluates in some sort of fragment-based URI which does not contain any information about the resource that contains the model object (e.g., hb:/#//MyComponent/MyParameterValue). By setting resolve to true, such fragment-based URIs will be automatically expanded to a URI that starts with the URI of the model object's resource and is followed by the fragment of the model object's native URI (e.g., platform:/resource/MyProject/MyResource/#//MyComponent/MyParameterValue).

Returns:

The URI representing the provided object.

getURI

protected org.eclipse.emf.common.util.URI getURI(org.eclipse.emf.common.util.URI resourceURI,
                                                 java.lang.String eObjectURIFragment,
                                                 boolean resolve)

getURI

protected org.eclipse.emf.common.util.URI getURI(org.eclipse.emf.common.util.URI resourceURI,
                                                 java.lang.String eObjectURIFragment)

getOldURI

protected org.eclipse.emf.common.util.URI getOldURI(org.eclipse.emf.ecore.EObject oldOwner,
                                                    org.eclipse.emf.ecore.EStructuralFeature oldFeature,
                                                    org.eclipse.emf.ecore.EObject eObject,
                                                    boolean resolve)

resolveURI

protected org.eclipse.emf.common.util.URI resolveURI(org.eclipse.emf.common.util.URI uri)

createURI

public org.eclipse.emf.common.util.URI createURI(java.lang.String uriLiteral,
                                                 org.eclipse.emf.ecore.EClass eClass)

Description copied from interface: ExtendedResource

Creates a URI from given uriLiteral that refers to an instance of given object type. This method is typically called during deserialization of resources when it comes to creating proxy URIs from serialized representations of cross-document references to objects in other resources.

Clients may implement/override this method when they require URIs with custom formats to be created

Specified by:

createURI in interface ExtendedResource

Parameters:

uriLiteral - The string representation of the URI to be created.

eClass - The type of object that the URI to be created is supposed to refer to.

Returns:

The URI corresponding to given uriLiteral.

getHREF

public org.eclipse.emf.common.util.URI getHREF(org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ExtendedResource

Returns a URI representing an HREF to given EObject stored in underlying Resource. This method is typically called during serialization of resources when it comes to creating serializable representations of cross-document references for objects being referenced from other resources.

Clients may implement/override this method when they require HREFs with custom formats to be created.

Specified by:

getHREF in interface ExtendedResource

Parameters:

eObject - The object for which the HREF URI is to be created.

Returns:

The HREF URI to this object from this resource.

nomalizeURIFragment

public java.lang.String nomalizeURIFragment(java.lang.String uriFragment)

Description copied from interface: ExtendedResource

Returns the normalized form of the given URI fragment.

This may, in theory, do absolutely anything. The general idea behind this feature is to support resources in which the URI fragments used to identify objects can have manifold forms. The URI fragments that refer to a given object can then no longer be assumed to be always the same. Instead they may have alternative forms and look differently from case to case (e.g., have an additional postfix in simple cases, or a completely different format in more advanced cases). The URI fragment normalization enables such manifold URI fragments to be converted into a common base form and make them comparable. There is no general assumption of what normalized URI fragments should look like except for that they always must evaluate to the same string when the original URI fragments refer to the same object.

It is important to emphasize that normalization can result in loss of information. The normalized URI fragment should generally be used only for the comparison of the identities of the objects being referred to.

Specified by:

nomalizeURIFragment in interface ExtendedResource

Parameters:

uriFragment - The URI fragment to normalize.

Returns:

The URI fragment in its normalized form, or the original URI fragment in case it already was normalized or the underlying resource type does not support alternative forms of URI fragments.

validateURI

public org.eclipse.emf.common.util.Diagnostic validateURI(java.lang.String uri)

Description copied from interface: ExtendedResource

Determines whether or not the given URI string represents a valid URI.

Specified by:

validateURI in interface ExtendedResource

Parameters:

uri - The URI string to be validated.

Returns:

Diagnostic.OK_INSTANCE if given URI string is a valid URI or a Diagnostic with complementary information on error otherwise.

augmentToContextAwareProxy

public void augmentToContextAwareProxy(org.eclipse.emf.ecore.EObject proxy)

Description copied from interface: ExtendedResource

Augments given proxy to a context-aware proxy by adding key/value pairs that contain the target metamodel descriptor and a context URI to the query string of the proxy URI. Those are required to support the resolution of proxified references between objects from different metamodels and to honor the resource scope of the proxy URI when it is being resolved.

Specified by:

augmentToContextAwareProxy in interface ExtendedResource

Parameters:

proxy - The proxy to be handled.

See Also:

ExtendedResource.trimProxyContextInfo(URI)

trimProxyContextInfo

public org.eclipse.emf.common.util.URI trimProxyContextInfo(org.eclipse.emf.common.util.URI proxyURI)

Description copied from interface: ExtendedResource

If given proxy URI contains proxy context-related key/value pairs on its query string, returns the URI formed by removing those key/value pairs or removing the query string entirely in case that no other key/value pairs exist; returns given proxy URI unchanged, otherwise.

Specified by:

trimProxyContextInfo in interface ExtendedResource

Parameters:

proxyURI - The context-aware proxy URI to be handled.

Returns:

The trimmed proxy URI.

See Also:

ExtendedResource.augmentToContextAwareProxy(EObject)

isAdapterForType

public boolean isAdapterForType(java.lang.Object type)

Specified by:

isAdapterForType in interface org.eclipse.emf.common.notify.Adapter

Overrides:

isAdapterForType in class org.eclipse.emf.common.notify.impl.AdapterImpl

setTarget

public void setTarget(org.eclipse.emf.common.notify.Notifier newTarget)

Specified by:

setTarget in interface org.eclipse.emf.common.notify.Adapter

Overrides:

setTarget in class org.eclipse.emf.common.notify.impl.AdapterImpl