Package com.nomagic.magicdraw.dependencymatrix.persistence

Class 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

    • Field Detail

      • filterStereotype

        private final Stereotype filterStereotype
        Access to the filter settings

      • diagram

        private final Diagram diagram
        Matrix diagram element

    • Constructor Detail

      • FilterSettings

        public FilterSettings​(Diagram diagram)
        Initializes access to the filter settings element
        Parameters:
        diagram - matrix diagram

      • FilterSettings

        public FilterSettings​(Diagram diagram,
                      Stereotype filterStereotype)

    • 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 includeSubtypes)
        Include subtypes element filter property
        Parameters:
        includeSubtypes - if all subtypes should be accepted

      • isTypesIncludeCustomTypes

        public boolean isTypesIncludeCustomTypes()
        Include custom types element filter property
        Specified by:
        isTypesIncludeCustomTypes in interface com.nomagic.magicdraw.ui.diagrams.scope.ScopeSettings
        Returns:
        true if all subtypes should be accepted

      • setTypesIncludeCustomTypes

        public void setTypesIncludeCustomTypes​(boolean includeCustomTypes)
        Include subtypes element filter property
        Parameters:
        includeCustomTypes - if all custom types 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

      • setQueryExpression

        public void setQueryExpression​(@CheckForNull
                               java.lang.String expression)
        Parameters:
        expression - query string expression

      • 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

      • getTypesIncludeCustomTypes

        public abstract java.lang.String getTypesIncludeCustomTypes()
        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

      • getQueryExpression

        @CheckForNull
public java.lang.String getQueryExpression()
        Specified by:
        getQueryExpression 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