org.modelio.api.modelio.diagram.autodiagram

Interface IAutoDiagramFactory

public interface IAutoDiagramFactory

The IAutoDiagramFactory provides the ability to create automatic diagram managers.

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

Automatic diagrams are meant to help analyze a design for maintenance, improvements or refactoring. Two main categories exist:

• Structure Diagrams, analyzing what an element contains, what it is.
• Position Diagrams, analyzing what role an element has in a system, where it is.

Since:

2.2

See Also:

IDiagramCreator

Method Summary

Modifier and Type	Method and Description
IDiagramCreator	createClassArchitectureCreator() Instanciates a new Diagram Creator for Class Architecture diagrams.
IDiagramCreator	createClassStructureCreator() Instanciates a new Diagram Creator for Class Structure diagrams.
IDiagramCreator	createDependencyCreator() Instanciates a new Diagram Creator for Dependency diagrams.
IDiagramCreator	createInheritanceCreator() Instanciates a new Diagram Creator for Inheritance diagrams.
IDiagramCreator	createPackageContentStructureCreator() Instanciates a new Diagram Creator for Package Content Structure diagrams.
IDiagramCreator	createSubPackageStructureCreator() Instanciates a new Diagram Creator for SubPackage Structure diagrams.

Method Detail

createClassStructureCreator

IDiagramCreator createClassStructureCreator()

Instanciates a new Diagram Creator for Class Structure diagrams.

A Class Structure diagram shows how a class is made, what it consists of, what it is in terms of inheritance.

For a class, it includes:

• The class itself in the center.
• Its public attributes.
• The parent classes/interfaces if any.
• The classes it is having an association to.
• The classes having a composition or aggregation towards it.

Returns:

a new Diagram Creator.

createInheritanceCreator

IDiagramCreator createInheritanceCreator()

Instanciates a new Diagram Creator for Inheritance diagrams.

A Class Inheritance diagram shows where a class is in its inheritance graph.

For a class, it includes:

• The class itself in the center.
• The parent classes/interfaces if any.
• The parent sub-classes if any.

Returns:

a new Diagram Creator.

createSubPackageStructureCreator

IDiagramCreator createSubPackageStructureCreator()

Instanciates a new Diagram Creator for SubPackage Structure diagrams.

A SubPackage Structure diagram shows the internal structure of a package in terms of packages, and the dependencies between them.

For a package, it includes:

• Its sub-packages.
• The blue links (NameSpaceUse) between those sub-packages.

Returns:

a new Diagram Creator.

createPackageContentStructureCreator

IDiagramCreator createPackageContentStructureCreator()

Instanciates a new Diagram Creator for Package Content Structure diagrams.

A SubPackage Structure diagram shows the internal structure of a package, and the links between them.

For a package, it includes:

• Its sub-classes/interfaces.
• The associations and inheritance relationships between them.

Returns:

a new Diagram Creator.

createDependencyCreator

IDiagramCreator createDependencyCreator()

Instanciates a new Diagram Creator for Dependency diagrams.

A Dependency diagram shows incoming and outgoing dependencies of a namespace.

For a namespace, it includes:

• The namespace itself in a central position.
• All elements having a dependency towards the namespace on the left.
• All elements having the namespace depends on on the right.

Returns:

a new Diagram Creator.

createClassArchitectureCreator

IDiagramCreator createClassArchitectureCreator()

Instanciates a new Diagram Creator for Class Architecture diagrams.

A Class Architecture diagram shows how a class is made, what it consists of, what it is in terms of inheritance and its place in the project.

For a class, it includes:

• The class itself in the center.
• Its public attributes.
• The parent classes/interfaces if any.
• The child classes/interfaces if any.
• The classes it is having an association to.
• The classes having any kind of association towards it.

Returns:

a new Diagram Creator.