org.eclipse.e4.ui.internal.workbench

Class ModelAssembler

java.lang.Object

org.eclipse.e4.ui.internal.workbench.ModelAssembler

public class ModelAssembler
extends java.lang.Object

The ModelAssembler is responsible for adding fragments and MApplicationElement imports to the application model and running pre- and post-processors on the model.

Constructor Summary

Constructors

Constructor and Description
ModelAssembler()

Method Summary

Modifier and Type	Method and Description
void	processFragment(MModelFragments fragmentsContainer, MModelFragment fragment, java.lang.String contributorName, java.lang.String contributorURI, boolean checkExist) Adds the model elements contributed by the IConfigurationElement to the application model and resolves any fragment imports along the way.
void	processFragments(java.util.Collection<ModelFragmentWrapper> fragmentList)
void	processFragmentWrappers(java.util.Collection<ModelFragmentWrapper> wrappers) Processes the given list of fragments wrapped in ModelFragmentWrapper elements.
void	processModel(boolean initial) Processes the application model.
java.util.List<MApplicationElement>	processModelFragment(MModelFragment fragment, java.lang.String contributorURI, boolean checkExist) Contributes the given MModelFragment to the application model.
void	resolveImports(java.util.List<MApplicationElement> imports, java.util.List<MApplicationElement> addedElements) Resolves the given list of imports used by the specified addedElements in the application model.
void	runProcessors(IExtension[] extensions, boolean initial, boolean afterFragments) Executes the processors as declared in provided extensions array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelAssembler

public ModelAssembler()

Method Detail

processModel

public void processModel(boolean initial)

Processes the application model. This will run pre-processors, process the fragments, resolve imports and run post-processors, in this order.
The org.eclipse.e4.workbench.model extension point will be used to retrieve the contributed fragments (with imports) and processors.
Extension points will be sorted based on the dependencies of their contributors.

Parameters:

initial - true if running from a non-persisted state

processFragmentWrappers

public void processFragmentWrappers(java.util.Collection<ModelFragmentWrapper> wrappers)

Processes the given list of fragments wrapped in ModelFragmentWrapper elements.

Parameters:

wrappers - the list of fragments

processFragments

public void processFragments(java.util.Collection<ModelFragmentWrapper> fragmentList)

processFragment

public void processFragment(MModelFragments fragmentsContainer,
                            MModelFragment fragment,
                            java.lang.String contributorName,
                            java.lang.String contributorURI,
                            boolean checkExist)

Adds the model elements contributed by the IConfigurationElement to the application model and resolves any fragment imports along the way.

Parameters:

fragmentsContainer - the MModelFragments

fragment - the MModelFragment

contributorName - the name of the element contributing the fragment

contributorURI - the URI of the element contribution the fragment

checkExist - specifies whether we should check that the application model doesn't already contain the elements contributed by the fragment before merging them

processModelFragment

public java.util.List<MApplicationElement> processModelFragment(MModelFragment fragment,
                                                                java.lang.String contributorURI,
                                                                boolean checkExist)

Contributes the given MModelFragment to the application model.

Parameters:

fragment - the fragment to add to the application model

contributorURI - the URI of the element that contributes this fragment

checkExist - specifies whether we should check that the application model doesn't already contain the elements contributed by the fragment before merging them

Returns:

a list of the MApplicationElement elements that were merged into the application model by the fragment

runProcessors

public void runProcessors(IExtension[] extensions,
                          boolean initial,
                          boolean afterFragments)

Executes the processors as declared in provided extensions array.

Parameters:

extensions - the array of IExtension extensions containing the processors

initial - true if the application is running from a non-persisted state

afterFragments - true if the processors that should be run before model fragments are merged are to be executed, false otherwise

resolveImports

public void resolveImports(java.util.List<MApplicationElement> imports,
                           java.util.List<MApplicationElement> addedElements)

Resolves the given list of imports used by the specified addedElements in the application model.

Parameters:

imports - the list of elements that were imported by fragments and should be resolved in the application model

addedElements - the list of elements contributed by the fragments to the application model