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

Interface IFilteredViewProvider

All Superinterfaces:

IViewProvider

All Known Implementing Classes:

ExtensionXMIViewModelProvider

public interface IFilteredViewProvider
extends IViewProvider

A specialized view provider that filters views by properties in the loading properties. The mechanism by which matching of filters is performed is unspecified, but filters are specified as key-value pairs in the properties parameter of each API method.

Since:

1.22

Field Summary

Fields inherited from interface org.eclipse.emf.ecp.view.spi.provider.IViewProvider

NOT_APPLICABLE

Method Summary

Modifier and Type	Method and Description
default double	canProvideViewModel(org.eclipse.emf.ecore.EObject eObject, VViewModelProperties properties) Queries whether I can provide without any filter properties being required.
double	canProvideViewModel(org.eclipse.emf.ecore.EObject object, VViewModelProperties properties, Collection<String> requiredKeys) Queries the confidence with which I can provide a view model for the given domain model object where some keys in the properties are required to be matched in an implementation-specific way by the view models the I have access to.
default VView	provideViewModel(org.eclipse.emf.ecore.EObject object, VViewModelProperties properties) Obtains a view model without any filter properties being required.
VView	provideViewModel(org.eclipse.emf.ecore.EObject object, VViewModelProperties properties, Collection<String> requiredKeys) Obtains the view model that I can provide for the given domain model object.

Method Detail

canProvideViewModel

default double canProvideViewModel(org.eclipse.emf.ecore.EObject eObject,
                                   VViewModelProperties properties)

Queries whether I can provide without any filter properties being required.

Specified by:

canProvideViewModel in interface IViewProvider

Parameters:

eObject - the EObject to create a

properties - the properties for providing the view

Returns:

a positive double indicating how well this provider is fitted to provide a VView for the provided EObject or IViewProvider.NOT_APPLICABLE if it doesn't fit

canProvideViewModel

double canProvideViewModel(org.eclipse.emf.ecore.EObject object,
                           VViewModelProperties properties,
                           Collection<String> requiredKeys)

Queries the confidence with which I can provide a view model for the given domain model object where some keys in the properties are required to be matched in an implementation-specific way by the view models the I have access to.

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 positive double indicating how well I am suited to provide a VView for the given object, or IViewProvider.NOT_APPLICABLE if I cannot provide a view model

provideViewModel

default VView provideViewModel(org.eclipse.emf.ecore.EObject object,
                               VViewModelProperties properties)

Obtains a view model without any filter properties being required.

Specified by:

provideViewModel in interface IViewProvider

Parameters:

object - the EObject to generate the VView for

properties - the properties for providing the view

Returns:

the generated VView

provideViewModel

VView provideViewModel(org.eclipse.emf.ecore.EObject object,
                       VViewModelProperties properties,
                       Collection<String> requiredKeys)

Obtains the view model that I can provide for the given domain model object. This method is only called if a previous invocation of canProvideViewModel(EObject, VViewModelProperties, Collection) with the same arguments returned the highest positive result amongst all available 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:

the view model