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

Interface EMFFormsFilteredViewService

All Superinterfaces:

EMFFormsViewService

All Known Implementing Classes:

ViewProviderImpl

public interface EMFFormsFilteredViewService
extends EMFFormsViewService

A specialization of the EMFFormsViewService protocol that makes explicit the support for filtering views by matching properties requested by the client. Thus it understands how to interact with IFilteredViewProviders that are #addProvider(IViewProvider) added to it.

Since:

1.22

See Also:

IFilteredViewProvider

Method Summary

Modifier and Type	Method and Description
default VView	getView(org.eclipse.emf.ecore.EObject object, VViewModelProperties properties) Retrieve a VView for a domain model object without any required filter keys.
VView	getView(org.eclipse.emf.ecore.EObject object, VViewModelProperties properties, Collection<String> requiredKeys) Retrieve a VView for a domain model object from the most confident of my registered view providers.

Methods inherited from interface org.eclipse.emf.ecp.view.spi.provider.EMFFormsViewService

addProvider, removeProvider

Method Detail

getView

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

Retrieve a VView for a domain model object without any required filter keys.

Specified by:

getView in interface EMFFormsViewService

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

Returns:

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

getView

VView getView(org.eclipse.emf.ecore.EObject object,
              VViewModelProperties properties,
              Collection<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