com.nomagic.magicdraw.dependencymatrix.persistence

Class FilterSettings

java.lang.Object

com.nomagic.magicdraw.dependencymatrix.persistence.FilterSettings

All Implemented Interfaces:

com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

@OpenApiAll
public abstract class FilterSettings
extends java.lang.Object
implements com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

Provides generic ability to access row or column filter settings.

Settings are stored directly in the Dependency Matrix diagram element, and retrieved directly

Constructor Summary

Constructors

Constructor and Description
FilterSettings(Stereotype filterStereotype, Diagram matrixElement) Initializes access to the filter settings element

Method Summary

Modifier and Type	Method and Description
static <T> java.util.List<T>	castList(java.util.List listValue) Checks if provided list is not EmptyList.
java.util.Collection<Element>	getAdditionalElements()
java.util.List<Element>	getElementTypes() Element types for rows/columns
abstract java.lang.String	getElementTypesTagName() Stereotype tag name of the dependency matrix filter stereotype, used to get the property value
protected Stereotype	getFilterStereotype()
protected Diagram	getMatrixElement()
Project	getProject()
java.util.List<java.lang.String>	getPropertyFilter() Dependency Matrix Property filter property
abstract java.lang.String	getPropertyFilterTagName() Stereotype tag name of the dependency matrix filter stereotype, used to get the property value
com.nomagic.magicdraw.expressions.specification.ExpressionSpecification	getQuery() Dependency Matrix Property query
java.util.Collection<java.lang.String>	getQueryExpressions()
abstract java.lang.String	getQueryTagName() Stereotype tag name of the dependency matrix filter stereotype, used to get the property value
java.util.Collection<Element>	getRemovedElements() Dependency matrix removed element property
abstract java.lang.String	getRemovedElementsTagName() Stereotype tag name of the dependency matrix filter stereotype, used to get the property value
java.util.Collection<Element>	getScope() Deprecated. use com.nomagic.magicdraw.dependencymatrix.persistence.FilterSettings#getScopeRoots()
abstract java.lang.String	getScopeDefinedTagName()
java.util.Collection<Element>	getScopeRoots()
abstract java.lang.String	getScopeTagName() Stereotype tag name of the dependency matrix filter stereotype, used to get the property value
abstract java.lang.String	getTypesIncludeSubtypes() Stereotype tag name of the dependency matrix filter stereotype, used to get the property value
boolean	isElementTypesDefined()
boolean	isRemoveChildrenOfRemovedElements()
boolean	isScopeDefined()
boolean	isTypesIncludeSubtypes() Include subtypes element filter property
void	setConvertedElementTypes(java.util.List<java.lang.Object> types) Converts element types and saves them as the diagram setting
void	setElementTypes(java.util.List<Element> types) Set element types for diagram
void	setPropertyFilter(java.util.List<java.lang.String> propertyFilter) Dependency Matrix Property filter property
void	setQuery(java.util.Collection<java.lang.String> expressions) Dependency Matrix Property query
void	setRemovedElements(java.util.Collection<Element> removedElements) update Dependency matrix removed element property
void	setScope(java.util.Collection<Element> scope) Dependency matrix scope property
void	setScopeDefined(boolean confirmed) Set scope confirmation flag
void	setTypesIncludeSubtypes(boolean include) Include subtypes element filter property

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

getName

Constructor Detail

FilterSettings

public FilterSettings(Stereotype filterStereotype,
                      Diagram matrixElement)

Initializes access to the filter settings element

Parameters:

filterStereotype - filter settings stereotype

matrixElement - element with settings

Method Detail

castList

public static <T> java.util.List<T> castList(java.util.List listValue)

Checks if provided list is not EmptyList. If so - returns new list. Otherwise - returns the same list

Parameters:

listValue - checked list

Returns:

list or new list

getElementTypes

public java.util.List<Element> getElementTypes()

Element types for rows/columns

Specified by:

getElementTypes in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

Returns:

ist of metaclass or stereotype instance

isElementTypesDefined

public boolean isElementTypesDefined()

Specified by:

isElementTypesDefined in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

setElementTypes

public void setElementTypes(java.util.List<Element> types)

Set element types for diagram

Parameters:

types - list of metaclass or stereotype instance

setConvertedElementTypes

public void setConvertedElementTypes(java.util.List<java.lang.Object> types)

Converts element types and saves them as the diagram setting

Parameters:

types - element types

getScopeRoots

public java.util.Collection<Element> getScopeRoots()

Specified by:

getScopeRoots in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

Returns:

scope root elements, used when collecting all elements in the scope

getScope

@Deprecated
public java.util.Collection<Element> getScope()

Deprecated. use com.nomagic.magicdraw.dependencymatrix.persistence.FilterSettings#getScopeRoots()

setScope

public void setScope(java.util.Collection<Element> scope)

Dependency matrix scope property

Parameters:

scope - scope element collection

getRemovedElements

public java.util.Collection<Element> getRemovedElements()

Dependency matrix removed element property

Specified by:

getRemovedElements in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

Returns:

element removed from the scope

isRemoveChildrenOfRemovedElements

public boolean isRemoveChildrenOfRemovedElements()

Specified by:

isRemoveChildrenOfRemovedElements in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

setRemovedElements

public void setRemovedElements(java.util.Collection<Element> removedElements)

update Dependency matrix removed element property

Parameters:

removedElements - element removed from the scope

isTypesIncludeSubtypes

public boolean isTypesIncludeSubtypes()

Include subtypes element filter property

Specified by:

isTypesIncludeSubtypes in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

Returns:

true if all subtypes should be accepted

setTypesIncludeSubtypes

public void setTypesIncludeSubtypes(boolean include)

Include subtypes element filter property

Parameters:

include - if all subtypes should be accepted

getPropertyFilter

public java.util.List<java.lang.String> getPropertyFilter()

Dependency Matrix Property filter property

Specified by:

getPropertyFilter in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

Returns:

property filter values

setPropertyFilter

public void setPropertyFilter(java.util.List<java.lang.String> propertyFilter)

Dependency Matrix Property filter property

Parameters:

propertyFilter - property filter values

getQuery

@CheckForNull
public com.nomagic.magicdraw.expressions.specification.ExpressionSpecification getQuery()

Dependency Matrix Property query

Returns:

query value

setQuery

public void setQuery(@CheckForNull
                     java.util.Collection<java.lang.String> expressions)

Dependency Matrix Property query

Parameters:

expressions - query string expressions

getElementTypesTagName

public abstract java.lang.String getElementTypesTagName()

Stereotype tag name of the dependency matrix filter stereotype, used to get the property value

Returns:

tag name

getScopeTagName

public abstract java.lang.String getScopeTagName()

Stereotype tag name of the dependency matrix filter stereotype, used to get the property value

Returns:

tag name

getRemovedElementsTagName

public abstract java.lang.String getRemovedElementsTagName()

Stereotype tag name of the dependency matrix filter stereotype, used to get the property value

Returns:

tag name

getTypesIncludeSubtypes

public abstract java.lang.String getTypesIncludeSubtypes()

Stereotype tag name of the dependency matrix filter stereotype, used to get the property value

Returns:

tag name

getPropertyFilterTagName

public abstract java.lang.String getPropertyFilterTagName()

Stereotype tag name of the dependency matrix filter stereotype, used to get the property value

Returns:

tag name

getScopeDefinedTagName

public abstract java.lang.String getScopeDefinedTagName()

getQueryTagName

public abstract java.lang.String getQueryTagName()

Stereotype tag name of the dependency matrix filter stereotype, used to get the property value

Returns:

tag name

getFilterStereotype

protected Stereotype getFilterStereotype()

getMatrixElement

protected Diagram getMatrixElement()

getProject

public Project getProject()

Specified by:

getProject in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

setScopeDefined

public void setScopeDefined(boolean confirmed)

Set scope confirmation flag

Parameters:

confirmed - flag value

isScopeDefined

public boolean isScopeDefined()

Specified by:

isScopeDefined in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

getQueryExpressions

@CheckForNull
public java.util.Collection<java.lang.String> getQueryExpressions()

Specified by:

getQueryExpressions in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings

getAdditionalElements

public java.util.Collection<Element> getAdditionalElements()

Specified by:

getAdditionalElements in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings