org.eclipse.sphinx.emf.explorer

Class BasicExplorerContentProvider

java.lang.Object

org.eclipse.sphinx.emf.explorer.BasicExplorerContentProvider

All Implemented Interfaces:

org.eclipse.emf.common.ui.viewer.IViewerProvider, org.eclipse.jface.viewers.IContentProvider, org.eclipse.jface.viewers.IStructuredContentProvider, org.eclipse.jface.viewers.ITreeContentProvider, org.eclipse.ui.navigator.ICommonContentProvider, org.eclipse.ui.navigator.IMementoAware

public class BasicExplorerContentProvider
extends java.lang.Object
implements org.eclipse.ui.navigator.ICommonContentProvider, org.eclipse.emf.common.ui.viewer.IViewerProvider

EMF model content provider for use with the Common Navigator framework. It deals with the workspace integration of the EMF model and internally delegates to EMF-based model content provider to get the children and parent of model objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.ui.navigator.INavigatorContentDescriptor	contentDescriptor
protected org.eclipse.emf.transaction.ResourceSetListener	crossReferenceChangedListener
protected static int	LIMIT_INDIVIDUAL_OBJECTS_REFRESH
protected static int	LIMIT_INDIVIDUAL_RESOURCES_REFRESH
protected java.util.Map<org.eclipse.emf.transaction.TransactionalEditingDomain,org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider>	modelContentProviders
protected org.eclipse.emf.transaction.ResourceSetListener	modelContentRootChangedListener
protected org.eclipse.emf.transaction.ResourceSetListener	resourceChangedListener
protected org.eclipse.emf.transaction.ResourceSetListener	resourceMovedListener
protected org.eclipse.jface.viewers.Viewer	viewer

Constructor Summary

Constructors

Constructor and Description
BasicExplorerContentProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTransactionalEditingDomainListeners(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)
protected void	applyViewerState(ITreeViewerState state)
protected org.eclipse.emf.transaction.ResourceSetListener	createCrossReferenceChangedListener()
protected org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider	createModelContentProvider(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)
protected org.eclipse.emf.transaction.ResourceSetListener	createModelContentRootChangedListener() Explicitly refreshes the corresponding workspace resources in case of changes among the direct children of the model root objects.
protected org.eclipse.emf.transaction.ResourceSetListener	createResourceChangedListener() Creates a ResourceSetChangedListener that detects (re-)loaded resources resources and refreshes their parent(s).
protected org.eclipse.emf.transaction.ResourceSetListener	createResourceMovedListener()
void	dispose()
protected org.eclipse.emf.common.notify.AdapterFactory	getAdapterFactory(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain) Returns the adapter factory to be used by this content provider for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.
java.lang.Object[]	getChildren(java.lang.Object parentElement)
protected ExtendedCommonNavigator	getCommonNavigator()
protected org.eclipse.emf.common.notify.AdapterFactory	getCustomAdapterFactory() Returns a custom adapter factory to be used by this content provider for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.
java.lang.Object[]	getElements(java.lang.Object inputElement)
protected java.lang.Object	getMappedModelRoot(org.eclipse.emf.ecore.EObject object) Deprecated. Use getModelContentRoot(EObject) instead.
protected org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider	getModelContentProvider(java.lang.Object object)
protected java.lang.Object	getModelContentRoot(org.eclipse.emf.ecore.EObject object) Deprecated. Use getModelContentRoots(Resource) instead.
protected java.lang.Object	getModelContentRoot(org.eclipse.emf.ecore.util.FeatureMap.Entry entry) Deprecated. Use getModelContentRoots(Resource) instead.
protected java.lang.Object	getModelContentRoot(org.eclipse.emf.edit.provider.IWrapperItemProvider wrapperItemProvider) Deprecated. Use getModelContentRoots(Resource) instead.
protected java.lang.Object	getModelContentRoot(java.lang.Object object) Deprecated. Use getModelContentRoots(Resource) instead.
protected java.lang.Object	getModelContentRoot(TransientItemProvider transientItemProvider) Deprecated. Use getModelContentRoots(Resource) instead.
protected java.util.List<java.lang.Object>	getModelContentRoots(org.eclipse.emf.ecore.resource.Resource modelResource) Returns a list of objects which are to be used as roots of the model content provided by this content provider for the given model resource.
protected org.eclipse.emf.ecore.resource.Resource	getModelResource(org.eclipse.core.resources.IResource workspaceResource) Retrieves the model resource behind specified workspace resource.
protected java.lang.Object	getModelRoot(org.eclipse.core.resources.IResource resource) Deprecated.
protected org.eclipse.emf.ecore.EObject	getModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file) Deprecated. Use getModelRoot(IResource) instead. Rationale: Navigation into models should not be supported only from files but also from projects and folders. The TransactionalEditingDomain can be easily retrieved inside the method and therefore does not need to be provided by the caller.
java.lang.Object	getParent(java.lang.Object element)
protected org.eclipse.core.resources.IResource	getUnderlyingWorkspaceResource(java.lang.Object modelContentRoot) Deprecated. Use getWorkspaceResource(Resource) instead.
org.eclipse.jface.viewers.Viewer	getViewer() Returns the viewer whose content is provided by this content provider.
protected org.eclipse.core.resources.IResource	getWorkspaceResource(org.eclipse.emf.ecore.resource.Resource modelResource) Returns the resource corresponding to given model resource.
boolean	hasChildren(java.lang.Object element)
void	init(org.eclipse.ui.navigator.ICommonContentExtensionSite config)
void	inputChanged(org.eclipse.jface.viewers.Viewer viewer, java.lang.Object oldInput, java.lang.Object newInput)
protected boolean	isPossibleChild(java.lang.Object object)
protected boolean	isTriggerPoint(org.eclipse.core.resources.IResource resource)
protected ITreeViewerState	recordViewerState()
protected void	refreshViewer() Refreshes viewer completely.
protected void	refreshViewerOnModelObjects(java.util.Set<?> objects) Refreshes viewer on specified model objects.
protected void	refreshViewerOnModelResources(java.util.Set<? extends org.eclipse.emf.ecore.resource.Resource> resources) Refreshes viewer on specified model resources.
protected void	refreshViewerOnObject(java.lang.Object object) Refreshes viewer on specified object.
protected void	refreshViewerOnWorkspaceResources(java.util.Set<? extends org.eclipse.core.resources.IResource> resources) Refreshes viewer on specified workspace resources.
protected void	removeTransactionalEditingDomainListeners(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)
void	restoreState(org.eclipse.ui.IMemento memento)
void	saveState(org.eclipse.ui.IMemento memento)

Methods inherited from class java.lang.Object

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

Field Detail

LIMIT_INDIVIDUAL_RESOURCES_REFRESH

protected static final int LIMIT_INDIVIDUAL_RESOURCES_REFRESH

See Also:

Constant Field Values

LIMIT_INDIVIDUAL_OBJECTS_REFRESH

protected static final int LIMIT_INDIVIDUAL_OBJECTS_REFRESH

See Also:

Constant Field Values

viewer

protected org.eclipse.jface.viewers.Viewer viewer

contentDescriptor

protected org.eclipse.ui.navigator.INavigatorContentDescriptor contentDescriptor

modelContentProviders

protected java.util.Map<org.eclipse.emf.transaction.TransactionalEditingDomain,org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider> modelContentProviders

resourceChangedListener

protected org.eclipse.emf.transaction.ResourceSetListener resourceChangedListener

resourceMovedListener

protected org.eclipse.emf.transaction.ResourceSetListener resourceMovedListener

crossReferenceChangedListener

protected org.eclipse.emf.transaction.ResourceSetListener crossReferenceChangedListener

modelContentRootChangedListener

protected org.eclipse.emf.transaction.ResourceSetListener modelContentRootChangedListener

Constructor Detail

BasicExplorerContentProvider

public BasicExplorerContentProvider()

Method Detail

getViewer

public org.eclipse.jface.viewers.Viewer getViewer()

Returns the viewer whose content is provided by this content provider.

Specified by:

getViewer in interface org.eclipse.emf.common.ui.viewer.IViewerProvider

Returns:

the viewer for this content provider

getCommonNavigator

protected ExtendedCommonNavigator getCommonNavigator()

recordViewerState

protected ITreeViewerState recordViewerState()

applyViewerState

protected void applyViewerState(ITreeViewerState state)

init

public void init(org.eclipse.ui.navigator.ICommonContentExtensionSite config)

Specified by:

init in interface org.eclipse.ui.navigator.ICommonContentProvider

isTriggerPoint

protected boolean isTriggerPoint(org.eclipse.core.resources.IResource resource)

isPossibleChild

protected boolean isPossibleChild(java.lang.Object object)

saveState

public void saveState(org.eclipse.ui.IMemento memento)

Specified by:

saveState in interface org.eclipse.ui.navigator.IMementoAware

restoreState

public void restoreState(org.eclipse.ui.IMemento memento)

Specified by:

restoreState in interface org.eclipse.ui.navigator.IMementoAware

getModelResource

protected org.eclipse.emf.ecore.resource.Resource getModelResource(org.eclipse.core.resources.IResource workspaceResource)

Retrieves the model resource behind specified workspace resource. Returns null if no such is available or the model behind specified workspace resource has not been loaded yet.

Default implementation supports the handling of file resources including lazy loading of the underlying models: if the given file belongs to some model that has not been loaded yet then the loading of that model, i.e., the given file and all other files belonging to the same, will be triggered. The model loading will be performed asynchronously and therefore won't block the UI. When the model loading has been completed, the resourceChangedListener automatically refreshes the underlying viewer so that the model elements contained by the given file become visible.

Clients may override this method so as to add support for other resource types (e.g., projects or folders) or implement different lazy or eager loading strategies.

Parameters:

workspaceResource - The workspace resource of which the model resource is to be retrieved.

Returns:

The model resource behind specified workspace resource or null if no such is available or the model behind specified workspace resource has not been loaded yet.

getModelContentRoots

protected java.util.List<java.lang.Object> getModelContentRoots(org.eclipse.emf.ecore.resource.Resource modelResource)

Returns a list of objects which are to be used as roots of the model content provided by this content provider for the given model resource. They may or may not be the actual root objects of the model resource.

The model content roots can be thought of being mapped to the workspace resource behind given model resource and are the actual parent objects of the model objects to be displayed as virtual children of the workspace resource. The model content roots themselves will not become visible in the underlying viewer, only the workspace resource they are mapped to and their children will.

This implementation returns a list containing the provided model resource itself as default. Clients are free to override and implement alternative behaviors as appropriate.

Parameters:

modelResource - The model resource of which the model content roots are to be retrieved.

Returns:

The list of notifier objects which are to be used as roots of the model content provided by this content provider.

getWorkspaceResource

protected org.eclipse.core.resources.IResource getWorkspaceResource(org.eclipse.emf.ecore.resource.Resource modelResource)

Returns the resource corresponding to given model resource.

Parameters:

modelResource - The model resource of which the workspace resource it to be returned.

Returns:

The workspace resource corresponding to given model resource.

See Also:

getModelResource(IResource)

getModelRoot

@Deprecated
protected java.lang.Object getModelRoot(org.eclipse.core.resources.IResource resource)

Deprecated.

Retrieves the model root behind specified resource. Returns null if no such is available or the model behind specified resource has not been loaded yet.

Default implementation supports the handling of file resources including lazy loading of the underlying models: if the given file belongs to some model that has not been loaded yet then the loading of that model, i.e., the given file and all other files belonging to the same model, will be triggered. The model loading will be done asynchronously and therefore won't block the UI. When the model loading has been completed, the resourceChangedListener automatically refreshes the underlying viewer so that the model elements contained by the given file become visible.

Clients may override this method so as to add support for other resource types (e.g., projects or folders) or implement different lazy or eager loading strategies.

Parameters:

resource - The resource whose model root is to be retrieved.

Returns:

The model root behind specified resource or null if no such is available or the model behind specified resource has not been loaded yet.

getModelRoot

@Deprecated
protected org.eclipse.emf.ecore.EObject getModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                    org.eclipse.core.resources.IFile file)

Deprecated. Use getModelRoot(IResource) instead. Rationale: Navigation into models should not be supported only from files but also from projects and folders. The TransactionalEditingDomain can be easily retrieved inside the method and therefore does not need to be provided by the caller.

Retrieves the root element of the model contained in the specified file. Returns null if that file has not yet been loaded into the ResourceSet of the specified editingDomain or if it is empty.

Default implementation provides a lazy loading mechanism. When the user expands an model file of some model which has not been loaded yet, this and all other model files which belong to that model will be loaded by that time. This loading will be done asynchronously using ModelLoadManager API, and therefore won't block the UI while the loading process is ongoing. Once the loading of the model will be finished, the refresh mechanism (i.e., the resource changed listener) will make sure that the view gets refreshed and the model elements inside the expanded model file become visible.

Clients may override this method in order to provide a custom lazy or eager loading strategy.

Parameters:

editingDomain - The editing domain owning the resource set inside which the resource corresponding to the specified file should be loaded.

file - The file which model root must be returned.

Returns:

The root element of the model owned by the specified file; or null if file has not been loaded.

getModelContentRoot

@Deprecated
protected java.lang.Object getModelContentRoot(java.lang.Object object)

Deprecated. Use getModelContentRoots(Resource) instead.

Returns the object or resource which is used as root of the model content provided by this content provider for given model object. The model content root is the model object that is mapped to the workspace resource under which the model behind given model object is made visible. It may or may not be the actual root object of the model. The model content root itself will not become visible in the underlying viewer, only the workspace resource it is mapped to and its children will.

Parameters:

object - An arbitrary model object to be investigated.

Returns:

The object or resource which is used as root of the model content provided by this content provider for given model object or null if given object is no model object or has no parent that corresponds to the expected model content root.

getModelContentRoot

@Deprecated
protected java.lang.Object getModelContentRoot(org.eclipse.emf.ecore.EObject object)

Deprecated. Use getModelContentRoots(Resource) instead.

Returns the object or resource which is used as root of the model content provided by this content provider for given model object. The model content root is the model object that is mapped to the workspace resource under which the model behind given model object is made visible. It may or may not be the actual root object of the model. The model content root itself will not become visible in the underlying viewer, only the workspace resource it is mapped to and its children will.

This implementation returns the resource behind given model object as model content root. Clients should override this method if they require some other model object to be used instead.

The most typical use cases and implementations of this method are as follows:

• The resource behind given model object is to be used as model content root:
  

  return object.eResource();

• The model root object behind given model object is to be used as model content root:
  

  return EcoreUtil.getRootContainer(object);

Parameters:

object - An arbitrary object to be investigated.

Returns:

The object or resource which is used as root of the model content provided by this content provider for given model object or null if given object is no model object or has no parent that corresponds to the expected model content root.

getMappedModelRoot

@Deprecated
protected java.lang.Object getMappedModelRoot(org.eclipse.emf.ecore.EObject object)

Deprecated. Use getModelContentRoot(EObject) instead.

getModelContentRoot

@Deprecated
protected java.lang.Object getModelContentRoot(org.eclipse.emf.edit.provider.IWrapperItemProvider wrapperItemProvider)

Deprecated. Use getModelContentRoots(Resource) instead.

getModelContentRoot

@Deprecated
protected java.lang.Object getModelContentRoot(org.eclipse.emf.ecore.util.FeatureMap.Entry entry)

Deprecated. Use getModelContentRoots(Resource) instead.

getModelContentRoot

@Deprecated
protected java.lang.Object getModelContentRoot(TransientItemProvider transientItemProvider)

Deprecated. Use getModelContentRoots(Resource) instead.

getUnderlyingWorkspaceResource

@Deprecated
protected org.eclipse.core.resources.IResource getUnderlyingWorkspaceResource(java.lang.Object modelContentRoot)

Deprecated. Use getWorkspaceResource(Resource) instead.

Returns the resource corresponding to given model content root.

Parameters:

modelContentRoot - The model content root object in question.

Returns:

The resource corresponding to given model content root.

See Also:

getModelContentRoot(Object)

getModelContentProvider

protected org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider getModelContentProvider(java.lang.Object object)

createModelContentProvider

protected org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider createModelContentProvider(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)

getAdapterFactory

protected org.eclipse.emf.common.notify.AdapterFactory getAdapterFactory(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)

Returns the adapter factory to be used by this content provider for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.

This implementation returns the adapter factory which is embedded in the given editingDomain by default. Clients which want to use an alternative adapter factory (e.g., an adapter factory that creates item providers which are specifically designed for the editor in which this content provider is used) may override getCustomAdapterFactory() and return any adapter factory of their choice. This custom adapter factory will then be returned as result by this method.

Parameters:

editingDomain - The editing domain whose embedded adapter factory is to be returned as default. May be left null if getCustomAdapterFactory() has been overridden and returns a non-null result.

Returns:

The adapter factory that will be used by this content provider. null if no custom adapter factory is provided through getCustomAdapterFactory() and no editingDomain has been specified.

See Also:

getCustomAdapterFactory()

getCustomAdapterFactory

protected org.eclipse.emf.common.notify.AdapterFactory getCustomAdapterFactory()

Returns a custom adapter factory to be used by this content provider for creating item providers which control the way how model elements from given editingDomain are displayed and can be edited.

This implementation returns null as default. Clients which want to use their own adapter factory (e.g., an adapter factory that creates item providers which are specifically designed for the editor in which this content provider is used) may override this method and return any adapter factory of their choice. This custom adapter factory will then be returned as result by getAdapterFactory(TransactionalEditingDomain).

Returns:

The custom adapter factory that is to be used by this content provider. null the default adapter factory returned by getAdapterFactory(TransactionalEditingDomain) should be used instead.

See Also:

getAdapterFactory(TransactionalEditingDomain)

inputChanged

public void inputChanged(org.eclipse.jface.viewers.Viewer viewer,
                java.lang.Object oldInput,
                java.lang.Object newInput)

Specified by:

inputChanged in interface org.eclipse.jface.viewers.IContentProvider

getElements

public java.lang.Object[] getElements(java.lang.Object inputElement)

Specified by:

getElements in interface org.eclipse.jface.viewers.IStructuredContentProvider

Specified by:

getElements in interface org.eclipse.jface.viewers.ITreeContentProvider

hasChildren

public boolean hasChildren(java.lang.Object element)

Specified by:

hasChildren in interface org.eclipse.jface.viewers.ITreeContentProvider

getChildren

public java.lang.Object[] getChildren(java.lang.Object parentElement)

Specified by:

getChildren in interface org.eclipse.jface.viewers.ITreeContentProvider

getParent

public java.lang.Object getParent(java.lang.Object element)

Specified by:

getParent in interface org.eclipse.jface.viewers.ITreeContentProvider

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.jface.viewers.IContentProvider

addTransactionalEditingDomainListeners

protected void addTransactionalEditingDomainListeners(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)

removeTransactionalEditingDomainListeners

protected void removeTransactionalEditingDomainListeners(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain)

createResourceChangedListener

protected org.eclipse.emf.transaction.ResourceSetListener createResourceChangedListener()

Creates a ResourceSetChangedListener that detects (re-)loaded resources resources and refreshes their parent(s).

createResourceMovedListener

protected org.eclipse.emf.transaction.ResourceSetListener createResourceMovedListener()

createCrossReferenceChangedListener

protected org.eclipse.emf.transaction.ResourceSetListener createCrossReferenceChangedListener()

createModelContentRootChangedListener

protected org.eclipse.emf.transaction.ResourceSetListener createModelContentRootChangedListener()

Explicitly refreshes the corresponding workspace resources in case of changes among the direct children of the model root objects.

!! Important note !! This is necessary because viewer refreshes triggered by the model content provider only affect the model content root objects but not the corresponding workspace resources. As the former are not represented by any tree item in the viewer none of these refreshes performed will have any visible effect.

Returns:

refreshViewerOnWorkspaceResources

protected void refreshViewerOnWorkspaceResources(java.util.Set<? extends org.eclipse.core.resources.IResource> resources)

Refreshes viewer on specified workspace resources.

Parameters:

resources -

refreshViewerOnModelResources

protected void refreshViewerOnModelResources(java.util.Set<? extends org.eclipse.emf.ecore.resource.Resource> resources)

Refreshes viewer on specified model resources.

Parameters:

resources -

refreshViewerOnModelObjects

protected void refreshViewerOnModelObjects(java.util.Set<?> objects)

Refreshes viewer on specified model objects.

Parameters:

objects -

refreshViewerOnObject

protected void refreshViewerOnObject(java.lang.Object object)

Refreshes viewer on specified object.

Parameters:

object -

refreshViewer

protected void refreshViewer()

Refreshes viewer completely.