com.nomagic.magicdraw.uml.symbols

Class DisplayRelatedSymbolsInfo

java.lang.Object

com.nomagic.magicdraw.uml.symbols.DisplayRelatedSymbolsInfo

@OpenApiAll
public class DisplayRelatedSymbolsInfo
extends java.lang.Object

Controls behavior of display related symbols functionality.

See Also:

DisplayRelatedSymbols, LinkType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DEPTH_LIMIT Default related element search depth limit.
static boolean	DEFAULT_IS_DEPTH_LIMITED Default is depth limited value.
static boolean	DEFAULT_IS_PACKAGE_SCOPE Default is package scope flag value.
static int	DEFAULT_RELATION_TYPE Default display relation type.
static int	RELATION_TYPE_BOTH Displays both clients and suppliers.
static int	RELATION_TYPE_CLIENT Displays only clients.
static int	RELATION_TYPE_SUPPLIER Displays only suppliers.

Constructor Summary

Constructors

Constructor and Description
DisplayRelatedSymbolsInfo(java.util.Set<LinkType> linkTypes)

Method Summary

Modifier and Type	Method and Description
int	getDepthLimit() Gets depth limit value.
java.util.Set<LinkType>	getLinkTypes() Gets link types for display related elements functionality.
int	getRelationType() Gets relation type flag value.
boolean	isCreateAnnotatedElements() Gets is create annotated elements flag value.
boolean	isCreateClients() Indicates if relationship clients should be created.
static boolean	isCreateClients(int relationType) Indicates if relationship clients should be created.
boolean	isCreateComments() Gets is create comments flag value.
boolean	isCreateContainment() Gets is create containment flag value.
boolean	isCreateNewSymbols() Gets is create new symbols flag value.
boolean	isCreateSuppliers() Indicates if relationship suppliers should be created.
static boolean	isCreateSuppliers(int relationType) Indicates if relationship suppliers should be created.
boolean	isDepthLimited() Gets is depth limited flag value.
boolean	isPackageScope() Gets is in package scope flag value.
void	setCreateAnnotatedElements(boolean isCreateAnnotatedElements) Sets is create annotated elements flag value.
void	setCreateComments(boolean isCreateComments) Sets is create comments flag value.
void	setCreateContainment(boolean isCreateContainment) Sets is create containment flag value.
void	setCreateNewSymbols(boolean createNewSymbols) Sets create new symbols flag value.
void	setDepthLimit(int depthLimit) Sets depth limit value.
void	setDepthLimited(boolean isDepthLimited) Sets is depth limited flag value.
void	setLinkTypes(java.util.Set<LinkType> linkTypes) Sets link types for display related elements functionality.
void	setPackageScope(boolean isPackageScope) Sets is in package scope flag value.
void	setRelationType(int relationType) Sets relation type flag value.

Methods inherited from class java.lang.Object

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

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

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.