com.modeliosoft.modelio.api.diagram.autodiagram

Interface IDiagramCreator

public interface IDiagramCreator

An IDiagramCreator provides the ability to create, update or get automatic diagrams from a model element.

Since:

2.2

See Also:

IAutoDiagramFactory

Structure Diagram

Method Summary

Methods

Modifier and Type	Method and Description
IAbstractDiagram	createDiagram(IModelElement main) Create or update an automatic diagram for the given element.
String	getAutoDiagramName() Get The type of the current auto diagram this creator is managing.
IAbstractDiagram	getExistingAutoDiagram(IModelElement main) Get the current auto diagram centered on the given element.

Method Detail

createDiagram

IAbstractDiagram createDiagram(IModelElement main)
                               throws StereotypeNotFoundException

Create or update an automatic diagram for the given element.

Only one automatic diagram of the current type can be created for an element.

Parameters:

main - The element to center the automatic diagram on.

Returns:

The corresponding automatic diagram.

Throws:

StereotypeNotFoundException - When the <> stereotype is missing.

getExistingAutoDiagram

IAbstractDiagram getExistingAutoDiagram(IModelElement main)

Get the current auto diagram centered on the given element.

Parameters:

main - The element to look a diagram for.

Returns:

The corresponding automatic diagram.

getAutoDiagramName

String getAutoDiagramName()

Get The type of the current auto diagram this creator is managing.

Returns:

the current auto diagram type.