com.yworks.yfiles.layout.partial

Enum ComponentAssignmentStrategy

java.lang.Object

java.lang.Enum<ComponentAssignmentStrategy>

com.yworks.yfiles.layout.partial.ComponentAssignmentStrategy

All Implemented Interfaces:

Serializable, Comparable<ComponentAssignmentStrategy>

public enum ComponentAssignmentStrategy
extends Enum<ComponentAssignmentStrategy>

See Also:

PartialLayout.getComponentAssignmentStrategy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUSTERING A component assignment strategy where the subgraph components correspond to the clusters computed by a clustering algorithm based on edge betweenness centrality.
CONNECTED A component assignment strategy where the subgraph components correspond to the connected components of the graph induced by the partial elements.
CUSTOMIZED A component assignment strategy where the subgraph components are defined by the user.
SINGLE A component assignment strategy that assigns each partial node to a separate subgraph component.

Method Summary

Modifier and Type	Method and Description
static ComponentAssignmentStrategy	fromOrdinal(int ordinal)
int	value()
static ComponentAssignmentStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComponentAssignmentStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLUSTERING

public static final ComponentAssignmentStrategy CLUSTERING

A component assignment strategy where the subgraph components correspond to the clusters computed by a clustering algorithm based on edge betweenness centrality.

Borders of groups and partition cells always split up the components, i.e., two nodes assigned to different groups or partition cells are always assigned to different subgraph components.

See Also:

PartialLayout.setComponentAssignmentStrategy(ComponentAssignmentStrategy)

CONNECTED

public static final ComponentAssignmentStrategy CONNECTED

A component assignment strategy where the subgraph components correspond to the connected components of the graph induced by the partial elements.

Borders of groups and partition cells always split up the components, i.e., two nodes assigned to different groups or partition cells are always assigned to different subgraph components.

See Also:

PartialLayout.setComponentAssignmentStrategy(ComponentAssignmentStrategy)

CUSTOMIZED

public static final ComponentAssignmentStrategy CUSTOMIZED

A component assignment strategy where the subgraph components are defined by the user. Two partial nodes are considered to be in the same component if the IDataProvider associated with key PartialLayout.COMPONENT_ID_DPKEY returns the same object for both of them.

Borders of groups and partition cells always split up the components, i.e., two nodes assigned to different groups or partition cells are always assigned to different subgraph components.

See Also:

PartialLayout.COMPONENT_ID_DPKEY, PartialLayout.setComponentAssignmentStrategy(ComponentAssignmentStrategy)

SINGLE

public static final ComponentAssignmentStrategy SINGLE

A component assignment strategy that assigns each partial node to a separate subgraph component.

Using this strategy, the specified core layout algorithm doesn't have any effect because it is applied to each subgraph component (i.e., each single node) separately.

See Also:

PartialLayout.setComponentAssignmentStrategy(ComponentAssignmentStrategy)

Method Detail

fromOrdinal

public static final ComponentAssignmentStrategy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static ComponentAssignmentStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static ComponentAssignmentStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ComponentAssignmentStrategy c : ComponentAssignmentStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared