|
||||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.emf.common.notify.impl.BasicNotifierImpl
org.eclipse.emf.common.notify.impl.NotifierImpl
org.eclipse.emf.ecore.resource.impl.ResourceSetImpl
An extensible resource set implementation.
The following configuration and control mechanisms are provided:
| Nested Class Summary | |
|---|---|
protected class |
ResourceSetImpl.ResourcesEList
A notifying list implementation for supporting ResourceSet.getResources(). |
| Nested classes inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl |
|---|
BasicNotifierImpl.EAdapterList |
| Field Summary | |
|---|---|
protected EList |
adapterFactories
The registered adapter factories. |
protected java.util.Map |
loadOptions
The load options. |
protected EPackage.Registry |
packageRegistry
The local package registry. |
protected Resource.Factory.Registry |
resourceFactoryRegistry
The local resource factory registry. |
protected EList |
resources
The contained resources. |
protected URIConverter |
uriConverter
The URI converter. |
protected java.util.Map |
uriResourceMap
A map to cache the resource associated with a specific URI. |
| 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.ResourceSet |
|---|
RESOURCE_SET__RESOURCES |
| Constructor Summary | |
|---|---|
ResourceSetImpl()
Creates an empty instance. |
|
| Method Summary | |
|---|---|
Resource |
createResource(URI uri)
Creates a new resource, of the appropriate type, and returns it. |
protected Resource |
delegatedGetResource(URI uri,
boolean loadOnDemand)
Returns a resolved resource available outside of the resource set. |
protected Resource |
demandCreateResource(URI uri)
Creates a new resource appropriate for the URI. |
protected void |
demandLoad(Resource resource)
Loads the given resource. |
protected void |
demandLoadHelper(Resource resource)
Demand loads the given resource using ResourceSetImpl.demandLoad(Resource)
and wraps any IOException as a runtime exception.
|
EList |
getAdapterFactories()
Returns the list of registered AdapterFactory instances.
|
TreeIterator |
getAllContents()
Returns a tree iterator that iterates over all the direct resources
and over the content tree of each. |
EObject |
getEObject(URI uri,
boolean loadOnDemand)
Returns the object resolved by the URI. |
java.util.Map |
getLoadOptions()
Returns the options used during demand load. |
EPackage.Registry |
getPackageRegistry()
Returns the registry used for looking up a package based namespace. |
Resource |
getResource(URI uri,
boolean loadOnDemand)
Returns the resource resolved by the URI. |
Resource.Factory.Registry |
getResourceFactoryRegistry()
Returns the registry used for creating a resource of the appropriate type. |
EList |
getResources()
Returns the direct Resources being managed.
|
URIConverter |
getURIConverter()
Returns the converter used to normalize URIs and to open streams. |
java.util.Map |
getURIResourceMap()
Returns the map used to cache the resource associated with a specific URI. |
protected void |
handleDemandLoadException(Resource resource,
java.io.IOException exception)
Handles the exception thrown during demand load by recording it as an error diagnostic and throwing a wrapping runtime exception. |
void |
setPackageRegistry(EPackage.Registry packageRegistry)
Set the registry used for looking up a package based namespace. |
void |
setResourceFactoryRegistry(Resource.Factory.Registry resourceFactoryRegistry)
Sets the registry used for creating resource of the appropriate type. |
void |
setURIConverter(URIConverter uriConverter)
Sets the converter used to normalize URIs and to open streams. |
void |
setURIResourceMap(java.util.Map uriResourceMap)
Sets the map used to cache the resource associated with a specific URI. |
java.lang.String |
toString()
Returns a standard label with the list of resources. |
| 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 |
|---|
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 |
protected EList resources
ResourceSetImpl.getResources()protected EList adapterFactories
ResourceSetImpl.getAdapterFactories()protected java.util.Map loadOptions
ResourceSetImpl.getLoadOptions()protected Resource.Factory.Registry resourceFactoryRegistry
ResourceSetImpl.getResourceFactoryRegistry()protected URIConverter uriConverter
ResourceSetImpl.getURIConverter()protected EPackage.Registry packageRegistry
ResourceSetImpl.getPackageRegistry()protected java.util.Map uriResourceMap
ResourceSetImpl.setURIResourceMap(Map)| Constructor Detail |
public ResourceSetImpl()
| Method Detail |
public java.util.Map getURIResourceMap()
associated with a specific URI.
ResourceSetImpl.setURIResourceMap(java.util.Map)public void setURIResourceMap(java.util.Map uriResourceMap)
null.
The map will be lazily loaded by the getResource method.
It is up to the client to clear the cache when it becomes invalid,
e.g., when the URI of a previously mapped resource is changed.
uriResourceMap - the new map or null.ResourceSetImpl.getURIResourceMap()public EList getResources()
ResourceSetResources being managed.
A resource added to this list
will be contained by this resource set.
If it was previously contained by a resource set, it will have been removed.
getResources in interface ResourceSetResource.getResourceSet()public TreeIterator getAllContents()
ResourceSetdirect resources
and over the content tree of each.
getAllContents in interface ResourceSetEObject.eAllContents(),
Resource.getAllContents(),
EcoreUtil.getAllContents(java.util.Collection)public EList getAdapterFactories()
ResourceSetAdapterFactory instances.
One style of adapter lookup supported by EMF
is via registered adapter factories.
Since these factories are accessible to any fully contained object via
eObject.eResource().getResourceSet().getAdapterFactories()they can be used to create adapters on demand, without going to the factory first.
getAdapterFactories in interface ResourceSetEcoreUtil.getRegisteredAdapter(EObject, Object),
AdapterFactory.adapt(Notifier, Object)public java.util.Map getLoadOptions()
ResourceSet
Options are handled generically as feature-to-setting entries.
They are passed to the resource when it is deserialized.
A resource will ignore options it doesn't recognize.
The options could even include things like an Eclipse progress monitor...
getLoadOptions in interface ResourceSetResource.load(Map)
public EObject getEObject(URI uri,
boolean loadOnDemand)
ResourceSet
Every object contained by a resource (or that is a proxy)
has a corresponding URI
that resolves to the object.
So for any object contained by a resource, the following is true.
eObject == eObject.eResource().getResourceSet().getEObject(EcoreUtil.getURI(eObject), false)
The URI without the fragment,
is used to resolve a resource.
If the resource resolves,
the fragment is used to resolve the object.
getEObject in interface ResourceSeturi - the URI to resolve.loadOnDemand - whether to create and load the resource, if it doesn't already exists.
Resource.getEObject(String),
ResourceSet.getResource(URI, boolean),
EcoreUtil.getURI(EObject)protected Resource demandCreateResource(URI uri)
getResource(URI, boolean)
when a URI that doesn't exist as a resource is demand loaded.
This implementation simply calls createResource(URI).
Clients may extend this as appropriate.
uri - the URI of the resource to create.
ResourceSetImpl.getResource(URI, boolean)
protected void demandLoad(Resource resource)
throws java.io.IOException
demandLoadHelper(Resource)
to perform a demand load.
This implementation simply calls resource.load(getLoadOptions()).
Clients may extend this as appropriate.
resource - a resource that isn't loaded.
java.io.IOException - if there are serious problems loading the resource.ResourceSetImpl.getResource(URI, boolean),
ResourceSetImpl.demandLoadHelper(Resource)protected void demandLoadHelper(Resource resource)
ResourceSetImpl.demandLoad(Resource)
and wraps any IOException as a runtime exception.
It is called by getResource(URI, boolean)
to perform a demand load.
resource - a resource that isn't loaded.ResourceSetImpl.demandLoad(Resource)
protected void handleDemandLoadException(Resource resource,
java.io.IOException exception)
throws java.lang.RuntimeException
resource - the resource that threw an exception while loading.
java.lang.RuntimeExceptionResourceSetImpl.demandLoadHelper(Resource)
protected Resource delegatedGetResource(URI uri,
boolean loadOnDemand)
getResource(URI, boolean)
after it has determined that the URI cannot be resolved
based on the existing contents of the resource set.
This implementation looks up the URI in the {#getPackageRegistry() local} package registry.
Clients may extend this as appropriate.
uri - the URIloadOnDemand - whether demand loading is required.
public Resource getResource(URI uri,
boolean loadOnDemand)
ResourceSet
A resource set is expected to implement the following strategy
in order to resolve the given URI to a resource.
First it uses it's URI converter to normalize the URI
and then to compare it with the normalized URI of each resource;
if it finds a match,
that resource becomes the result.
Failing that,
it delegates
to allow the URI to be resolved elsewhere.
For example,
the package registry
is used to resolve
the namespace URI of a package
to the static instance of that package.
So the important point is that an arbitrary implementation may resolve the URI to any resource,
not necessarily to one contained by this particular resource set.
If the delegation step fails to provide a result,
and if loadOnDemand is true,
a resource is created
and that resource becomes the result.
If loadOnDemand is true
and the result resource is not loaded,
it will be loaded before it is returned.
getResource in interface ResourceSeturi - the URI to resolve.loadOnDemand - whether to create and load the resource, if it doesn't already exists.
public Resource createResource(URI uri)
ResourceSet
It delegates to the resource factory registry
to determine the correct factory,
and then it uses that factory to create the resource
and add it to the contents.
If there is no registered factory, null will be returned;
when running within Eclipse,
a default XMI factory will be registered,
and this will never return null.
createResource in interface ResourceSeturi - the URI of the resource to create.
null if no factory is registered.public Resource.Factory.Registry getResourceFactoryRegistry()
ResourceSet
An implementation will typically provide a registry that delegates to
the global resource factory registry.
As a result, registrations made in this registry are local to this resource set,
i.e., they augment or override those of the global registry.
getResourceFactoryRegistry in interface ResourceSetpublic void setResourceFactoryRegistry(Resource.Factory.Registry resourceFactoryRegistry)
ResourceSet
setResourceFactoryRegistry in interface ResourceSetresourceFactoryRegistry - the new registry.public URIConverter getURIConverter()
ResourceSet
getURIConverter in interface ResourceSetURIConverter,
URIpublic void setURIConverter(URIConverter uriConverter)
ResourceSet
setURIConverter in interface ResourceSeturiConverter - the new converter.URIConverter,
URIpublic EPackage.Registry getPackageRegistry()
ResourceSet
An implementation will typically provide a registry that delegates to
the global package registry.
As a result, registrations made in this registry are local to this resource set,
i.e., they augment or override those of the global registry.
getPackageRegistry in interface ResourceSetpublic void setPackageRegistry(EPackage.Registry packageRegistry)
ResourceSet
setPackageRegistry in interface ResourceSetpackageRegistry - the new registry.public java.lang.String toString()
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||