com.nomagic.magicdraw.dependencymatrix.configuration

Class MatrixDataHelper

java.lang.Object

com.nomagic.magicdraw.dependencymatrix.configuration.MatrixDataHelper

@OpenApiAll
public class MatrixDataHelper
extends java.lang.Object

Helper used to get and manage Dependency Matrix Data from external plugins.

Please pay attention, that if the Dependency Matrix diagram is not opened, its data is not collected and dependency matrix component needs to be built.

Constructor Summary

Constructors

Constructor and Description
MatrixDataHelper()

Method Summary

Modifier and Type	Method and Description
static MatrixData	buildMatrix(Diagram matrix) Collects all data for provided matrix data component.
static MatrixData	getMatrixData(Diagram matrix) Gets the matrix diagram data object.
static boolean	isRebuildNeeded(Diagram matrix) Checks if the current Dependency Matrix data is up to date or even are collected.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatrixDataHelper

public MatrixDataHelper()

Method Detail

getMatrixData

@CheckForNull
public static MatrixData getMatrixData(Diagram matrix)

Gets the matrix diagram data object. Pleas note, that if the matrix is not already opened, it will be witout data. If you need to manage not opened matrices use MatrixDataHelper.buildMatrix() method

Parameters:

matrix - diagram of the dependency matrix

Returns:

Dependency Matrix data component for specified diagram or null if this dependency matrix was not found. Before using data make sure if the matrix data is up to date and does not need to be rebuilt

buildMatrix

@CheckForNull
public static MatrixData buildMatrix(Diagram matrix)

Collects all data for provided matrix data component. This may be CPU/Time intensive task, so use it only in cases, when not opened matrix diagrams have to be used

Parameters:

matrix - Dependency Matrix diagram instance

Returns:

Dependency Matrix data component for specified diagram or null if this dependency matrix was not found

isRebuildNeeded

public static boolean isRebuildNeeded(Diagram matrix)

Checks if the current Dependency Matrix data is up to date or even are collected. If this method returns true you need to call MatrixDataHelper.buildMatrix() in order to get correct data

Parameters:

matrix - Dependency Matrix diagram instance

Returns:

true if rebuild is required