org.modelio.api.ui.viewtemplate

Interface IModelViewTemplate<T extends MObject>

public interface IModelViewTemplate<T extends MObject>

A Model View template creates a well-defined specific view from a so-called 'base' element. Views are persisted MObject defining a representation of some part of a model, a view is currently either a diagram or a matrix. The exact usage or role of the 'base' element depends on the template implementation and goals. Model View Template are identified by a unique identifier getId(). Several 'standard' model views template comes with Modelio, additional ones can be contributed either by extra-plugins or modules.

Method Summary

Modifier and Type	Method and Description
T	createView(ModelElement base) Create the view for a given element.
T	getExistingView(ModelElement base) Get the existing view for a given element.
java.lang.String	getId() Get the unique identifier of a model view template.
ModelElement	getMainElement(T view) Get the base element the view was created from.
ModelElement	resolveOrigin(ModelElement base) Get the composition owner that this creator would use to create a view for main element base.
void	updateView(T existingView) Update a view for the given element.

Method Detail

getId

java.lang.String getId()

Get the unique identifier of a model view template.

Returns:

the model view template Id.

createView

T createView(ModelElement base)

Create the view for a given element.

Parameters:

base - The element used by the creator to create the view. Depending on the creator behavior this element can simply be the composition parent of the created diagram or be interpreted differently (example subject of the diagram).

Returns:

The created view.

getExistingView

T getExistingView(ModelElement base)

Get the existing view for a given element. Must implement the same 'main' element interpretation as in createView(ModelElement)

Parameters:

base - The element to look a view for.

Returns:

The corresponding view or null.

updateView

void updateView(T existingView)

Update a view for the given element.

Parameters:

existingView - the view to be updated. Must be the one returned by getExistingView(ModelElement).

resolveOrigin

ModelElement resolveOrigin(ModelElement base)

Get the composition owner that this creator would use to create a view for main element base. This defines the 'base element' resolution algorithm implementation for this template.

Parameters:

base - the base element

Returns:

the current view origin.

getMainElement

ModelElement getMainElement(T view)

Get the base element the view was created from. This is the inverse resolution of getExistingView(ModelElement).

Parameters:

view - a MObject representing a view.

Returns:

The element the view was created for by this template.