Package org.eclipse.emf.ecp.view.spi.provider

Class ViewProviderHelper

java.lang.Object

org.eclipse.emf.ecp.view.spi.provider.ViewProviderHelper

public final class ViewProviderHelper
extends java.lang.Object

Util class for retrieving a VView based on an EObject.

Since:

1.2

Author:

Eugen Neufeld

Method Summary

Modifier and Type	Method	Description
static VView	getView(org.eclipse.emf.ecore.EObject eObject, VViewModelProperties properties)	This allows to retrieve a VView based on an EObject.
static VView	getView(org.eclipse.emf.ecore.EObject object, VViewModelProperties properties, java.util.Collection<java.lang.String> requiredKeys)	Retrieve a VView for a domain model object from the most confident of my registered view providers.

Methods inherited from class java.lang.Object

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

Method Detail

getView

public static VView getView(org.eclipse.emf.ecore.EObject eObject,
                            VViewModelProperties properties)

This allows to retrieve a VView based on an EObject. This method reads all IViewProviders and searches for the best fitting. If none can be found, then null is returned.

Parameters:

eObject - the EObject to find a VView for

properties - the properties. May be null

Returns:

a view model for the given EObject or null if no suited provider could be found

Since:

1.7

getView

public static VView getView(org.eclipse.emf.ecore.EObject object,
                            VViewModelProperties properties,
                            java.util.Collection<java.lang.String> requiredKeys)

Retrieve a VView for a domain model object from the most confident of my registered view providers.

Parameters:

object - the domain model object for which a view is to be requested

properties - the properties for providing the view, that may or may not include matching filters

requiredKeys - a subset (possibly empty) of the keys in the properties that must be matched by any view model that I would provide. If any of these keys does not match a view model, then that view model must not be provided. Otherwise, it may just be less preferred than some other view model that does match

Returns:

a view model for the given domain model object or null if no suitable provider could be found to provide one

Since:

1.22