Package com.nomagic.magicdraw.uml.symbols

Class DisplayRelatedSymbolsInfo

  • @OpenApiAll
public class DisplayRelatedSymbolsInfo
extends java.lang.Object
    Controls behavior of display related symbols functionality.
    See Also:
    DisplayRelatedSymbols, LinkType

    • Field Detail

      • RELATION_TYPE_BOTH

        public static final int RELATION_TYPE_BOTH
        Displays both clients and suppliers.
        See Also:
        Constant Field Values

      • RELATION_TYPE_CLIENT

        public static final int RELATION_TYPE_CLIENT
        Displays only clients.
        See Also:
        Constant Field Values

      • RELATION_TYPE_SUPPLIER

        public static final int RELATION_TYPE_SUPPLIER
        Displays only suppliers.
        See Also:
        Constant Field Values

      • DEFAULT_RELATION_TYPE

        public static final int DEFAULT_RELATION_TYPE
        Default display relation type.
        See Also:
        Constant Field Values

      • DEFAULT_IS_PACKAGE_SCOPE

        public static final boolean DEFAULT_IS_PACKAGE_SCOPE
        Default is package scope flag value.
        See Also:
        Constant Field Values

      • DEFAULT_IS_DEPTH_LIMITED

        public static final boolean DEFAULT_IS_DEPTH_LIMITED
        Default is depth limited value.
        See Also:
        Constant Field Values

      • DEFAULT_DEPTH_LIMIT

        public static final int DEFAULT_DEPTH_LIMIT
        Default related element search depth limit.
        See Also:
        Constant Field Values

      • linkTypes

        private java.util.Set<LinkType> linkTypes
        Contains link types to be displayed.

      • isPackageScope

        private boolean isPackageScope
        Indicates whether related elements should be searched in the nearest package scope from the given symbol element. False searches in the whole project.

      • isDepthLimited

        private boolean isDepthLimited
        Indicates whether depth of related element search via relationship should be limited.

      • depthLimit

        private int depthLimit
        Depth limit of related elements search.

      • isCreateContainment

        private boolean isCreateContainment
        Indicates whether containment relationship should be included in related elements display.

      • isCreateComments

        private boolean isCreateComments
        Indicates whether comments should be included in related elements display.

      • isCreateAnnotatedElements

        private boolean isCreateAnnotatedElements
        Indicates whether annotated elements should be included in related elements display.

      • mCreateNewSymbols

        private boolean mCreateNewSymbols
        True if existing symbols should be reused, false otherwise.

    • Constructor Detail

      • DisplayRelatedSymbolsInfo

        public DisplayRelatedSymbolsInfo​(java.util.Set<LinkType> linkTypes)

    • Method Detail

      • isCreateClients

        public static boolean isCreateClients​(int relationType)
        Indicates if relationship clients should be created.
        Parameters:
        relationType - value of relation type flag.
        Returns:
        true if relationship clients should be created, false otherwise.

      • isCreateClients

        public boolean isCreateClients()
        Indicates if relationship clients should be created.
        Returns:
        true if relationship clients should be created, false otherwise.

      • isCreateSuppliers

        public static boolean isCreateSuppliers​(int relationType)
        Indicates if relationship suppliers should be created.
        Parameters:
        relationType - value of relation type flag.
        Returns:
        true if relationship suppliers should be created, false otherwise.

      • isCreateSuppliers

        public boolean isCreateSuppliers()
        Indicates if relationship suppliers should be created.
        Returns:
        true if relationship suppliers should be created, false otherwise.

      • getRelationType

        public int getRelationType()
        Gets relation type flag value.
        Returns:
        relation type flag value.

      • setRelationType

        public void setRelationType​(int relationType)
        Sets relation type flag value.
        Parameters:
        relationType - relation type flag value.

      • getLinkTypes

        public java.util.Set<LinkType> getLinkTypes()
        Gets link types for display related elements functionality.
        Returns:
        link types.

      • setLinkTypes

        public void setLinkTypes​(java.util.Set<LinkType> linkTypes)
        Sets link types for display related elements functionality.
        Parameters:
        linkTypes - link types to set.

      • isPackageScope

        public boolean isPackageScope()
        Gets is in package scope flag value.
        Returns:
        is in package scope flag value.

      • setPackageScope

        public void setPackageScope​(boolean isPackageScope)
        Sets is in package scope flag value.
        Parameters:
        isPackageScope - is in package scope flag value.

      • isDepthLimited

        public boolean isDepthLimited()
        Gets is depth limited flag value.
        Returns:
        is depth limited flag value.

      • setDepthLimited

        public void setDepthLimited​(boolean isDepthLimited)
        Sets is depth limited flag value.
        Parameters:
        isDepthLimited - is depth limited flag value.

      • getDepthLimit

        public int getDepthLimit()
        Gets depth limit value.
        Returns:
        depth limit value.

      • setDepthLimit

        public void setDepthLimit​(int depthLimit)
        Sets depth limit value.
        Parameters:
        depthLimit - depth limit value.

      • isCreateContainment

        public boolean isCreateContainment()
        Gets is create containment flag value.
        Returns:
        create containment flag value.

      • setCreateContainment

        public void setCreateContainment​(boolean isCreateContainment)
        Sets is create containment flag value.
        Parameters:
        isCreateContainment - is create containment flag value.

      • isCreateComments

        public boolean isCreateComments()
        Gets is create comments flag value.
        Returns:
        is create comments flag value.

      • setCreateComments

        public void setCreateComments​(boolean isCreateComments)
        Sets is create comments flag value.
        Parameters:
        isCreateComments - is create comments flag value.

      • isCreateAnnotatedElements

        public boolean isCreateAnnotatedElements()
        Gets is create annotated elements flag value.
        Returns:
        is create annotated elements flag value.

      • setCreateAnnotatedElements

        public void setCreateAnnotatedElements​(boolean isCreateAnnotatedElements)
        Sets is create annotated elements flag value.
        Parameters:
        isCreateAnnotatedElements - is create annotated elements flag value.

      • isCreateNewSymbols

        public boolean isCreateNewSymbols()
        Gets is create new symbols flag value.
        Returns:
        is create new symbols flag value.

      • setCreateNewSymbols

        public void setCreateNewSymbols​(boolean createNewSymbols)
        Sets create new symbols flag value.
        Parameters:
        createNewSymbols - create new symbols flag value.