IlvCircularLayout (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.graphlayout.IlvGraphLayout
- - ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout
  - - ilog.views.graphlayout.circular.IlvCircularLayout

All Implemented Interfaces:

GraphModelListener, Serializable, EventListener
```
public class IlvCircularLayout
extends IlvBasicLinkStyleLayout
```
The main class for the Circular Layout algorithm.
The Circular Layout algorithm displays graphs representing interconnected ring and/or star network topologies. The algorithm takes into account the size of the nodes and tries to avoid overlapping nodes.

Here are sample drawings produced by the Circular Layout algorithm:

For the layout algorithm to work, you must provide information about the topology of the network, that is about how the network should be divided into interconnected clusters.
The layout algorithm provides three clustering modes (see setClusteringMode(int)):
- Clustering by cluster identifiers
  For each node of the graph, you must specify the cluster (that is, either the ring or the star) to which it belongs. Note that a node can belong to more than one cluster. To do this, you can use the methods setClusterId(Object, IlvClusterId) and addClusterId(Object, IlvClusterId). The class IlvClusterId is the abstract base class that is used as the identifier for the clusters. You can use one of its subclasses provided in JViews (IlvClusterName and IlvClusterNumber) or write your own subclass.
  
  In addition, for each cluster (ring or star), you can specify the order of the nodes along the cluster (with the exception of the central node for star clusters). To do this, you must use the methods setClusterId(Object, IlvClusterId, int) and addClusterId(Object, IlvClusterId, int), where the last argument is an integer index value associated with the node and the cluster. If the index values are provided, the layout algorithm places the nodes on the cluster in the order specified by the indexes.
  
  Note that in this mode the initial position of the nodes (at the moment you start the layout) does not affect the resulting layout. However, nodes specified as fixed are not moved if you call the method IlvGraphLayout.setPreserveFixedNodes(boolean) with a true argument.
- Clustering automatically
  This mode works similar to the clustering by cluster identifiers, however you do not need to specify cluster information for all nodes. The topology of the graph is analyzed to determine the clusters. A link crossing reduction heuristic is used to determine the order of the nodes within the clusters. Additionally, you can specify cluster ids or cluster indexe for some nodes, in the same way as in the mode clustering by cluster identifiers.
- Clustering by subgraphs
  In this mode, the algorithm handles a nested graph including intergraph links. It arranges the nodes of each subgraph on a circle, so that the number of link crossings is small. It respects the intergraph links and rotates the cluster so that the number of link crossings is small.
  
  It assumes that all nodes are nearly square, all nodes are in subgraphs, but the subgraph nesting is only 1. Nodes that are inside subgraphs of subgraphs are not anymore handles.
  
  Note that in this mode each subgraph keeps its initial position. The subgraphs can be placed either by a different layout algorithm, or interactively.
The following figure illustrates the dimensional parameters of the layout algorithm (clustering by cluster identifiers).

See the corresponding chapter of the User's Manual for details on the algorithm, the types of graphs for which this algorithm can be used, the features and limitations, code samples, parameters, and so on.
Since:

JViews 2.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUTOMATIC` Automatic clustering.
`static int`	`BY_CLUSTER_IDS` Clustering by cluster IDs mode.
`static int`	`BY_SUBGRAPHS` Clustering by subgraphs mode.
`static int`	`NO_INDEX` This value is returned by the method `getIndex` when a node has no index value with respect to a given cluster.
`static int`	`NO_RESHAPE_STYLE` No links reshape option.
`static int`	`STRAIGHT_LINE_STYLE` Straight-line links shape option.

Fields inherited from class ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout
ALL_CORNERS, BOTTOM_LEFT, BOTTOM_RIGHT, CENTERED, CLOCK_WISE, CONNECTED_ONE_BEND_BUNDLE, CONNECTED_RECTANGULAR, CONNECTED_SQUARE, COUNTER_CLOCK_WISE, FREE_ONE_BEND_BUNDLE, FREE_RECTANGULAR, FREE_SQUARE, HORIZONTAL_TO_VERTICAL, INNER, NARROW_CONNECTED_RECTANGULAR, NARROW_CONNECTED_SQUARE, NARROW_FREE_RECTANGULAR, NARROW_FREE_SQUARE, NARROW_STRAIGHT_LINE_BUNDLE, NO_BENDS, NO_BUNDLE, OUTER, STRAIGHT_LINE_BUNDLE, TOP_LEFT, TOP_RIGHT, VERTICAL_TO_HORIZONTAL

Fields inherited from class ilog.views.graphlayout.IlvGraphLayout
INVERSE_VIEW_COORDINATES, MANAGER_COORDINATES, VIEW_COORDINATES

Constructor Summary

Constructors
Constructor and Description
`IlvCircularLayout()` Creates a new instance of the Circular Layout algorithm.
`IlvCircularLayout(IlvCircularLayout source)` Creates a new layout instance by copying an existing one.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClusterId(Object node, IlvClusterId id)` Allows you to add a cluster identifier `id` to the list of cluster identifiers to which `node` belongs.
`void`	`addClusterId(Object node, IlvClusterId id, int index)` Allows you to add a cluster identifier `id` to the list of cluster identifiers to which `node` belongs.
`protected boolean`	`clusterize()` Clusters the graph.
`IlvGraphLayout`	`copy()` Copies the layout instance.
`void`	`copyParameters(IlvGraphLayout source)` Copies the parameters from a given layout instance.
`protected IlvGraphLayoutGrapherProperty`	`createLayoutGrapherProperty(String name, boolean withDefaults)` Returns a new instance of `IlvCircularLayoutGrapherProperty` that stores the parameter settings of this layout class.
`protected IlvGraphLayoutNodeProperty`	`createLayoutNodeProperty(String name, IlvGraphic node, boolean withDefaults)` Returns a new instance of `IlvCircularLayoutNodeProperty` that stores the parameter settings of this layout class for nodes.
`protected void`	`customizeLayoutOfClusterGraph(IlvGraphLayout layout)` Customize the layout of the cluster graph before it is applied.
`void`	`detach()` Detaches the graph model from the layout instance.
`IlvPoint`	`getClusterCenter(int clusterIndex)` Returns the center of the cluster of index `clusterIndex`.
`Vector`	`getClusterIds()` Returns the identifiers of all clusters (rings and/or stars) that are detected in the graph.
`Enumeration`	`getClusterIds(Object node)` Returns an enumeration of the cluster identifiers for the clusters to which `node` belongs.
`int`	`getClusterIdsCount(Object node)` Returns the number of cluster identifiers to which `node` belongs.
`int`	`getClusteringMode()` Returns the current clustering mode.
`Vector`	`getClusterNodes(int clusterIndex)` Returns the nodes that are contained in the cluster of index `clusterIndex`.
`double`	`getClusterRadius(int clusterIndex)` Returns the radius of the cluster of index `clusterIndex`.
`double`	`getDisconnectedGraphOffset()` Returns the offset between disconnected groups of clusters (rings and/or stars).
`int`	`getHighDegreeStarClusterSize()` Returns the minimum size to create star clusters from nodes with high degree.
`int`	`getIndex(Object node, IlvClusterId clusterId)` Returns the index of `node` with respect to its order on the cluster that is identified by `clusterId`.
`double`	`getInterClusterLinkCrossingPenalty()` Returns the penalty for crossings of links between nodes of different cluster.
`double`	`getIntraClusterLinkCrossingPenalty()` Returns the penalty for crossings of links between nodes of the same cluster.
`IlvGraphLayout`	`getLayoutOfClusterGraph()` Returns the layout instance that lays out the graph of clusters.
`double`	`getLevelOffset()` Returns the level offset value.
`int`	`getMaximumClusterSize()` Returns the maximum number of nodes to form a cluster.
`int`	`getMaximumNumberOfIterationsToReachMaxClusterSize()` Returns the number of iterations to achieve the maximum cluster size.
`int`	`getMaxNumberOfPermutations()` Returns the maximum number of permutations tested for a cluster of more than 7 nodes.
`int`	`getMinimumClusterSize()` Returns the minimum number of nodes to form a cluster.
`double`	`getMixedClusterLinkCrossingPenalty()` Returns the penalty for crossings of intra cluster links with inter cluster links.
`double`	`getOffset()` Returns the offset value.
`IlvClusterId[]`	`getRootClusterIds()` Returns the cluster identifiers (instances of `IlvClusterId`) of the root clusters, as specified using the method `setRootClusterId`.
`protected void`	`init()` Initializes instance variables.
`protected void`	`internalLayout(boolean redraw)` Computes the layout using the Circular Layout algorithm.
`boolean`	`isAreaMinimizationEnabled()` Returns whether total area minimization is enabled.
`boolean`	`isClusterByBiconnectivity()` Returns whether the clustering by biconnectivity is enabled.
`boolean`	`isInterClusterCrossingReduction()` Returns whether the crossing reduction takes inter cluster links into account.
`boolean`	`isStarCenter(Object node)` Returns `true` if `node` is the central node of a star cluster, and `false` otherwise.
`void`	`removeAllClusterIds(Object node)` Removes `node` from all clusters to which it belongs.
`void`	`removeAllRootClusterIds()` Allows you to reset all the root cluster settings.
`void`	`removeClusterId(Object node, IlvClusterId id)` Removes `node` from the cluster `id`.
`void`	`removeRootClusterId(IlvClusterId clusterId)` Allows you to specify that a cluster is no longer the root of the connected component of the graph of clusters to which it belongs.
`void`	`setAreaMinimizationEnabled(boolean option)` Sets whether the total area minimization option is enabled.
`void`	`setClusterByBiconnectivity(boolean enable)` Sets whether the clustering by biconnectivity is enabled.
`void`	`setClusterId(Object node, IlvClusterId id)` Allows you to specify that `node` belongs to a unique cluster of a given identifier `id`.
`void`	`setClusterId(Object node, IlvClusterId id, int index)` Allows you to specify that `node` belongs to a unique cluster of a given identifier `id` and is associated with the integer value `index`.
`void`	`setClusteringMode(int mode)` Sets the clustering mode.
`void`	`setDisconnectedGraphOffset(double offsetValue)` Sets the offset between disconnected groups of clusters (rings and/or stars).
`void`	`setHighDegreeStarClusterSize(int size)` Sets the minimum size to create star clusters from nodes with high degree.
`void`	`setInterClusterCrossingReduction(boolean enable)` Sets whether the crossing reduction takes inter cluster links into account.
`void`	`setInterClusterLinkCrossingPenalty(double penalty)` Sets the penalty for crossings of links between nodes of different clusters.
`void`	`setIntraClusterLinkCrossingPenalty(double penalty)` Sets the penalty for crossings of links between nodes of the same cluster.
`void`	`setLayoutOfClusterGraph(IlvGraphLayout layout)` Returns the layout instance that lays out the graph of clusters.
`void`	`setLevelOffset(double offsetValue)` Sets the offset between two concentric levels.
`void`	`setMaximumClusterSize(int size)` Sets the maximum number of nodes to form a cluster.
`void`	`setMaximumNumberOfIterationsToReachMaxClusterSize(int numIterations)` Sets the number of iterations to achieve the maximum cluster size.
`void`	`setMaxNumberOfPermutations(int n)` Sets the maximum number of permutations tested for a cluster of more than 7 nodes.
`void`	`setMinimumClusterSize(int size)` Sets the minimum number of nodes to form a cluster.
`void`	`setMixedClusterLinkCrossingPenalty(double penalty)` Sets the penalty for crossings of intra cluster links with inter cluster links.
`void`	`setOffset(double offsetValue)` Sets the offset value.
`void`	`setRootClusterId(IlvClusterId clusterId)` Allows you to specify a root cluster for the connected component of the graph of clusters to which it belongs.
`void`	`setRootClusterIds(IlvClusterId[] clusterIds)` Allows you to specify the root cluster for each connected component of the graph of clusters.
`void`	`setStarCenter(Object node, boolean starCenter)` Allows you to specify whether `node` is the central node of a star cluster.
`void`	`setStructureUpToDate(boolean uptodate)` Sets whether the structure of the graph is up to date.
`boolean`	`supportsAllowedTime()` Indicates that this layout class can not stop the layout computation when the user-defined allowed time is exceeded.
`boolean`	`supportsLayoutRegion()` Indicates that this layout class takes into account a user-defined region (a rectangle) or a user-defined manager view to compute the dimensions of the drawing.
`boolean`	`supportsPercentageComplete()` Indicates that this layout class can not estimate the percentage of completion during the layout run.
`boolean`	`supportsStopImmediately()` Indicates that this layout class can interrupt the current run of the layout immediately in a controlled way.

Methods inherited from class ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout
checkAppropriateLink, checkAppropriateLinks, getLayoutCodeOnInterrupt, getLinkStyle, getMovingNodes, getMultiLinkMaxSpread, getMultiLinkMode, getMultiLinkOffset, getMultiLinksCount, getMultiSelfLinkDistribution, getMultiSelfLinkMaxSpread, getMultiSelfLinkOffset, getPercentagesOfCompletion, getSelfLinkAbsoluteAttachPosition, getSelfLinkAllowedCorners, getSelfLinkMode, getSelfLinkOrientation, getSelfLinkRelativeAttachPosition, getSelfLinksCount, getSelfLinkSpacing, increasePercentageComplete, isConnectLinksToNodeCenters, isInterrupted, isSelfLinkConnectToNodeCenter, layout, setConnectLinksToNodeCenters, setLinkStyle, setMultiLinkMaxSpread, setMultiLinkMode, setMultiLinkOffset, setMultiSelfLinkDistribution, setMultiSelfLinkMaxSpread, setMultiSelfLinkOffset, setSelfLinkAbsoluteAttachPosition, setSelfLinkAllowedCorners, setSelfLinkConnectToNodeCenter, setSelfLinkMode, setSelfLinkOrientation, setSelfLinkRelativeAttachPosition, setSelfLinkSpacing, supportsLayoutOfConnectedComponents, supportsLinkClipping, supportsLinkConnectionBox, supportsPreserveFixedLinks, supportsPreserveFixedNodes, supportsSaveParametersToNamedProperties

Methods inherited from class ilog.views.graphlayout.IlvGraphLayout
addGraphLayoutEventListener, addGraphLayoutParameterEventListener, afterLayoutOfSubgraph, attach, attach, beforeLayout, beforeLayoutOfSubgraph, callLayoutStepPerformedIfNeeded, cleanGraphModel, cleanLink, cleanNode, clipAllLinks, clipLink, connectAllLinksToCenter, connectLinkToCenter, contentsChanged, createLayoutLinkProperty, createLayoutReport, getAllowedTime, getAutoLayoutHandler, getBalanceSplineCurveThreshold, getCalcLayoutRegion, getCoordinatesMode, getGrapher, getGraphModel, getInstanceId, getLayout, getLayoutOfConnectedComponents, getLayoutOfConnectedComponentsReport, getLayoutRegion, getLayoutReport, getLayouts, getLinkClipInterface, getLinkConnectionBoxInterface, getMaxSplineCurveSize, getMinBusyTime, getMinSplineCurveSize, getParentLayout, getProperty, getProperty, getRecursiveLayout, getRemainingAllowedTime, getSeedValueForRandomGenerator, getSpecLayoutRegion, getSplineLinkFilter, isAnimate, isAutoLayout, isFitToView, isFixed, isGeometryUpToDate, isInputCheckEnabled, isLayoutNeeded, isLayoutOfConnectedComponentsEnabled, isLayoutOfConnectedComponentsEnabledByDefault, isLayoutRunning, isLayoutRunning, isLayoutTimeElapsed, isLocalRecursiveLayoutNeeded, isMemorySavings, isParametersUpToDate, isPreserveFixedLinks, isPreserveFixedNodes, isSplineRoutingEnabled, isStoppedImmediately, isStructureUpToDate, isUseDefaultParameters, isUseSeedValueForRandomGenerator, layoutStepPerformed, onParameterChanged, onParameterChanged, performAutoLayout, performLayout, performLayout, performLayout, PerformLayout, performSublayout, removeGraphLayoutEventListener, removeGraphLayoutParameterEventListener, setAllowedTime, setAnimate, setAutoCheckAppropriateLinksEnabled, setAutoLayout, setAutoLayoutHandler, setBalanceSplineCurveThreshold, setCoordinatesMode, setFixed, setGeometryUpToDate, setGrapher, setGraphModel, setInputCheckEnabled, setLayoutOfConnectedComponents, setLayoutOfConnectedComponentsEnabled, setLayoutRegion, setLayoutRegion, setLayoutRegion, setLayoutReport, setLayoutRunning, setLinkClipInterface, setLinkConnectionBoxInterface, setMaxSplineCurveSize, setMemorySavings, setMinBusyTime, setMinSplineCurveSize, setParametersUpToDate, setParentLayout, setPreserveFixedLinks, setPreserveFixedNodes, setProperty, setProperty, setSeedValueForRandomGenerator, setSplineLinkFilter, setSplineRoutingEnabled, setUseDefaultParameters, setUseSeedValueForRandomGenerator, stopImmediately, supportsAnimation, supportsMemorySavings, supportsRandomGenerator, supportsSplineRouting, unfixAllLinks, unfixAllNodes, useAnimateRedraw

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_INDEX
```
public static final int NO_INDEX
```
    This value is returned by the method getIndex when a node has no index value with respect to a given cluster.
    
    See Also:
    
    getIndex(Object, IlvClusterId), Constant Field Values
  - BY_CLUSTER_IDS
```
public static final int BY_CLUSTER_IDS
```
    Clustering by cluster IDs mode. When used as the argument of the method setClusteringMode(int), the graph is divided into clusters on the basis of the IlvClusterId objects provided for each node.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    addClusterId(Object, IlvClusterId, int), setClusteringMode(int), Constant Field Values
  - BY_SUBGRAPHS
```
public static final int BY_SUBGRAPHS
```
    Clustering by subgraphs mode.
    When used as the argument of the method setClusteringMode(int), the graph is divided into clusters on the basis of the structure of the nested graph. (For details, see setClusteringMode(int).)
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setClusteringMode(int), Constant Field Values
  - AUTOMATIC
```
public static final int AUTOMATIC
```
    Automatic clustering.
    When used as the argument of the method setClusteringMode(int), the graph is divided into clusters by analysing the topology. (For details, see setClusteringMode(int).)
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setClusteringMode(int), Constant Field Values
  - STRAIGHT_LINE_STYLE
```
public static final int STRAIGHT_LINE_STYLE
```
    Straight-line links shape option. When used as an argument of IlvBasicLinkStyleLayout.setLinkStyle(int), the links are given a straight-line shape.
    
    See Also:
    
    IlvBasicLinkStyleLayout.setLinkStyle(int), Constant Field Values
  - NO_RESHAPE_STYLE
```
public static final int NO_RESHAPE_STYLE
```
    No links reshape option. When used as an argument of IlvBasicLinkStyleLayout.setLinkStyle(int), the links are not reshaped.
    
    See Also:
    
    IlvBasicLinkStyleLayout.setLinkStyle(int), Constant Field Values
- Constructor Detail
  - IlvCircularLayout
```
public IlvCircularLayout()
```
    Creates a new instance of the Circular Layout algorithm.
    To indicate the grapher you want to lay out, use the method attach(IlvGrapher).
    To indicate the graph model you want to lay out, use the method attach(IlvGraphModel).
    To perform the layout, use the method performLayout.
    To modify the layout parameters, use the different methods provided in this class and its superclass.
    
    See Also:
    
    IlvGraphLayout.attach(ilog.views.IlvGrapher), IlvGraphLayout.attach(ilog.views.graphlayout.IlvGraphModel), IlvGraphLayout.performLayout(), IlvGrapherAdapter.addLayer(ilog.views.IlvManagerLayer), IlvGrapherAdapter.setFilter(ilog.views.graphlayout.IlvLayoutGraphicFilter)
  - IlvCircularLayout
```
public IlvCircularLayout(IlvCircularLayout source)
```
    Creates a new layout instance by copying an existing one. This constructor is used by the copy() method. Any subclass should provide a copy constructor.
    The parameters of the source layout are copied using the method copyParameters(IlvGraphLayout).
    
    Parameters:
    
    source - The layout instance that is copied.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    copy(), copyParameters(IlvGraphLayout)
- Method Detail
  - copyParameters
```
public void copyParameters(IlvGraphLayout source)
```
    Copies the parameters from a given layout instance.
    Note that the parameters which are specific to a node or a link are not copied. The other parameters, including the link clip and link connection box interfaces, are also copied. A copy of the layout instance used for laying out the connected components is set on this layout instance.
    
    If a method of the type supportsXXX is associated with a parameter, the parameter is copied only if the corresponding method returns true.
    
    Overrides:
    
    copyParameters in class IlvBasicLinkStyleLayout
    
    Parameters:
    
    source - The layout instance from which the parameters are copied.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    IlvBasicLinkStyleLayout.copy()
  - init
```
protected void init()
```
    Initializes instance variables.
    You should not call this method directly. The method is called internally by the constructor without arguments and by the copy constructor. The method must be overridden by subclasses that need to initialize additional instance variables.
    
    Overrides:
    
    init in class IlvBasicLinkStyleLayout
    
    Since:
    
    JViews 5.0
  - copy
```
public IlvGraphLayout copy()
```
    Copies the layout instance.
    This method copies the layout instance by calling the copy constructor.
    
    When performing a recursive layout of a nested graph, IlvLayoutProvider uses this method to "clone" the layout instance of a parent graph.
    
    Note that the parameters specific to a node or link are not copied. The other parameters, including the layout region specification and he link clip and link connection box interfaces, are also copied.
    
    If a method of the type supportsXXX is associated with a parameter, the parameter is copied only if the corresponding method returns true.
    
    Overrides:
    
    copy in class IlvBasicLinkStyleLayout
    
    Returns:
    
    A copy of the layout instance.
    
    Since:
    
    JViews 5.0
  - detach
```
public void detach()
```
    Detaches the graph model from the layout instance. When you attach a new graph model to the layout instance, you do not need to detach the old graph model because this is done automatically when you call IlvGraphLayout.attach(IlvGraphModel). The detach method performs cleaning operations on the graph model. In addition to the cleaning operations in the base class, the Circular Layout algorithm removes the cluster ID and the star center attribute from the nodes.
    Note that you must call this method when you no longer need the layout instance. Otherwise, some objects may not be garbage collected.
    
    Overrides:
    
    detach in class IlvGraphLayout
    
    See Also:
    
    IlvGraphLayout.attach(IlvGraphModel), setClusterId(Object, IlvClusterId, int)
  - internalLayout
```
protected void internalLayout(boolean redraw)
                       throws IlvGraphLayoutException
```
    Computes the layout using the Circular Layout algorithm. To start the layout, call the method IlvGraphLayout.performLayout(boolean, boolean, boolean).
    Note that if the attached graph model is an IlvGrapherAdapter and clustering information was not provided (using the method setClusterId(Object, IlvClusterId, int) or addClusterId(Object, IlvClusterId, int), clustering information eventually stored in IlvClusterInfoProperty) is automatically read.
    
    Overrides:
    
    internalLayout in class IlvBasicLinkStyleLayout
    
    Throws:
    
    IlvGraphLayoutException - when no cluster (ring or star) was found, that is, if cluster information is not available. Also, the subclass IlvInappropriateLinkException can be thrown when laying out an IlvGrapher containing links that cannot be reshaped to a straight line.
    
    See Also:
    
    IlvGraphLayout.performLayout(boolean, boolean, boolean), IlvGraphLayout.getCalcLayoutRegion()
  - setRootClusterId
```
public void setRootClusterId(IlvClusterId clusterId)
```
    Allows you to specify a root cluster for the connected component of the graph of clusters to which it belongs.
    If a root cluster is not specified for a connected component of the graph of clusters, an arbitrary cluster is used.
    
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    clusterId - The cluster identifier of the root cluster.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    getRootClusterIds(), removeRootClusterId(IlvClusterId), removeAllRootClusterIds()
  - removeRootClusterId
```
public void removeRootClusterId(IlvClusterId clusterId)
```
    Allows you to specify that a cluster is no longer the root of the connected component of the graph of clusters to which it belongs.
    If a root cluster is not specified for a connected component of the graph of clusters, an arbitrary cluster is used.
    
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    clusterId - The cluster identifier.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    setRootClusterId(IlvClusterId), getRootClusterIds(), removeAllRootClusterIds()
  - removeAllRootClusterIds
```
public void removeAllRootClusterIds()
```
    Allows you to reset all the root cluster settings. Arbitrary clusters are used as root clusters for each connected component of the graph of clusters.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    getRootClusterIds(), removeRootClusterId(IlvClusterId), setRootClusterId(IlvClusterId)
  - setRootClusterIds
```
public void setRootClusterIds(IlvClusterId[] clusterIds)
```
    Allows you to specify the root cluster for each connected component of the graph of clusters.
    If a root cluster is not specified for a connected component of the graph of clusters, an arbitrary cluster is used.
    
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    clusterIds - The cluster identifiers of the root clusters.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    getRootClusterIds(), removeRootClusterId(IlvClusterId), removeAllRootClusterIds()
  - getRootClusterIds
```
public IlvClusterId[] getRootClusterIds()
```
    Returns the cluster identifiers (instances of IlvClusterId) of the root clusters, as specified using the method setRootClusterId.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    This method returns null if no root clusters have been specified. In this case, arbitrary root clusters will be used for each connected component of the graph of clusters.
    
    Returns:
    
    The identifiers of the root clusters.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setRootClusterId(IlvClusterId), removeRootClusterId(IlvClusterId), removeAllRootClusterIds()
  - setStructureUpToDate
```
public void setStructureUpToDate(boolean uptodate)
```
    Sets whether the structure of the graph is up to date.
    If the argument is false, notifies the layout instance that the structure of the graph was changed since the last time the layout was successfully performed.
    
    Usually you do not need to call this method. The method is automatically called with a true argument each time the layout is successfully performed.
    
    Overrides:
    
    setStructureUpToDate in class IlvGraphLayout
    
    See Also:
    
    IlvGraphLayout.isStructureUpToDate(), IlvGraphLayout.isLayoutNeeded()
  - clusterize
```
protected boolean clusterize()
```
    Clusters the graph. This method is called by the Circular Layout algorithm to create the internal representation of the clustered graph. The method uses the clustering information provided by the methods setClusterId and addClusterId.
    
    Returns:
    
    false if no clusters were detected, true otherwise.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    setClusterId(Object, IlvClusterId, int), addClusterId(Object, IlvClusterId, int)
  - setStarCenter
```
public final void setStarCenter(Object node,
                                boolean starCenter)
```
    Allows you to specify whether node is the central node of a star cluster.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    starCenter - true if the node is the central node of a star cluster.
    
    Since:
    
    JViews 3.0 This method replaces setStarCenter(IlvGraphic, boolean).
    
    See Also:
    
    isStarCenter(Object)
  - isStarCenter
```
public boolean isStarCenter(Object node)
```
    Returns true if node is the central node of a star cluster, and false otherwise.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    Returns:
    
    true if the node is the central node of a star cluster.
    
    Since:
    
    JViews 3.0 This method replaces isStarCenter(IlvGraphic).
    
    See Also:
    
    setStarCenter(Object, boolean)
  - setClusterId
```
public final void setClusterId(Object node,
                               IlvClusterId id)
```
    Allows you to specify that node belongs to a unique cluster of a given identifier id.
    Note that you must specify a different instance of IlvClusterId for each node.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    id - The cluster ID.
    
    Throws:
    
    IllegalArgumentException - if node is not (or is no longer) a node of the attached grapher.
    
    Since:
    
    JViews 3.0 This method replaces setClusterId(IlvGraphic, IlvClusterId).
    
    See Also:
    
    getClusterIds(Object)
  - setClusterId
```
public final void setClusterId(Object node,
                               IlvClusterId id,
                               int index)
```
    Allows you to specify that node belongs to a unique cluster of a given identifier id and is associated with the integer value index. (The index is used by the layout algorithm to determine the ordering of the nodes on the cluster.)
    Note that index must not be negative. The values of the indexes for consecutive nodes in a cluster are not necessarily consecutive. Only the order of the values is important.
    
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    id - The cluster ID.
    
    index - The index.
    
    Throws:
    
    IllegalArgumentException - if node is not (or is no longer) a node of the attached grapher.
    
    Since:
    
    JViews 3.0 This method replaces setClusterId(IlvGraphic, IlvClusterId, int).
    
    See Also:
    
    getClusterIds(Object)
  - addClusterId
```
public final void addClusterId(Object node,
                               IlvClusterId id)
```
    Allows you to add a cluster identifier id to the list of cluster identifiers to which node belongs.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    id - The cluster ID.
    
    Throws:
    
    IllegalArgumentException - if node is not (or is no longer) a node of the attached grapher.
    
    Since:
    
    JViews 3.0 This method replaces addClusterId(IlvGraphic, IlvClusterId).
    
    See Also:
    
    getClusterIds(Object)
  - addClusterId
```
public final void addClusterId(Object node,
                               IlvClusterId id,
                               int index)
```
    Allows you to add a cluster identifier id to the list of cluster identifiers to which node belongs. It also adds the associated integer value index (to be used by the layout algorithm to determine the order of the nodes on the cluster).
    Note that index must not be negative. The values of the indexes for consecutive nodes in a cluster are not necessarily consecutive. Only the order of the values is important.
    
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    id - The cluster ID.
    
    index - The index.
    
    Throws:
    
    IllegalArgumentException - if node is not (or is no longer) a node of the attached grapher.
    
    Since:
    
    JViews 3.0 This method replaces addClusterId(IlvGraphic, IlvClusterId, int).
    
    See Also:
    
    getClusterIds(Object)
  - removeClusterId
```
public final void removeClusterId(Object node,
                                  IlvClusterId id)
```
    Removes node from the cluster id.
    Note that you do not need to use the same instance of IlvClusterId as you used when you called setClusterId or addClusterId. You can use another instance if the instances are equal with respect to the method IlvClusterId.equals.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    id - The cluster ID.
    
    Since:
    
    JViews 3.0 This method replaces removeClusterId(IlvGraphic, IlvClusterId).
    
    See Also:
    
    getClusterIds(Object)
  - removeAllClusterIds
```
public final void removeAllClusterIds(Object node)
```
    Removes node from all clusters to which it belongs.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    Since:
    
    JViews 3.0 This method replaces removeAllClusterIds(IlvGraphic).
    
    See Also:
    
    getClusterIds(Object)
  - getClusterIds
```
public Vector getClusterIds()
```
    Returns the identifiers of all clusters (rings and/or stars) that are detected in the graph. The returned vector contains instances of IlvClusterId or subclasses. It returns null if there are no cluster identifiers.
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Returns:
    
    The identifiers of all clusters.
  - getClusterRadius
```
public double getClusterRadius(int clusterIndex)
```
    Returns the radius of the cluster of index clusterIndex. The index corresponds to the index of elements in the vector returned by the method getClusterIds. Therefore, valid values of clusterIndex range from zero to the number of clusters minus one (that is, the size of the vector returned by the method getClusterIds() minus one).
    Note that the returned value may not be correct if the nodes of the cluster have been moved since the layout was performed.
    
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    clusterIndex - The cluster index.
    
    Returns:
    
    The radius of the specified cluster.
    
    See Also:
    
    getClusterIds()
  - getClusterCenter
```
public IlvPoint getClusterCenter(int clusterIndex)
```
    Returns the center of the cluster of index clusterIndex. The index corresponds to the index of elements in the vector returned by the method getClusterIds. Therefore, valid values of clusterIndex range from zero to the number of clusters minus one (that is, the size of the vector returned by the method getClusterIds() minus one).
    Note that the returned value will not be correct if the nodes of the cluster have been moved since the layout was performed.
    
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    clusterIndex - The cluster index.
    
    Returns:
    
    The center of the specified cluster.
    
    See Also:
    
    getClusterIds()
  - getClusterNodes
```
public Vector getClusterNodes(int clusterIndex)
```
    Returns the nodes that are contained in the cluster of index clusterIndex. This index corresponds to the index of elements in the vector returned by the method getClusterIds. Therefore, valid values of clusterIndex range from zero to the number of clusters minus one (that is, the size of the vector returned by the method getClusterIds() minus one).
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    clusterIndex - The cluster index.
    
    Returns:
    
    The nodes that are contained in the specified cluster.
    
    See Also:
    
    getClusterIds()
  - getClusterIds
```
public Enumeration getClusterIds(Object node)
```
    Returns an enumeration of the cluster identifiers for the clusters to which node belongs. The elements of the enumeration are instances of IlvClusterId or subclasses.
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    Returns:
    
    The enumeration of the cluster identifiers for the clusters to which the specified node belongs.
    
    Since:
    
    JViews 3.0 This method replaces getClusterIds(IlvGraphic).
    
    See Also:
    
    setClusterId(Object, IlvClusterId, int), addClusterId(Object, IlvClusterId, int), removeClusterId(Object, IlvClusterId)
  - getClusterIdsCount
```
public int getClusterIdsCount(Object node)
```
    Returns the number of cluster identifiers to which node belongs.
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    Returns:
    
    The numer of cluster identifiers to which the specified node belongs.
    
    Since:
    
    JViews 3.0 This method replaces getClusterIdsCount(IlvGraphic).
    
    See Also:
    
    getClusterIds(java.lang.Object)
  - getIndex
```
public int getIndex(Object node,
                    IlvClusterId clusterId)
```
    Returns the index of node with respect to its order on the cluster that is identified by clusterId. It returns NO_INDEX if node has no index on the cluster.
    This method should be used only if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Parameters:
    
    node - The node.
    
    clusterId - The cluster ID.
    
    Returns:
    
    The index of the specifeid node with respect to its order on the cluster that is identified by the specified cluster identifier.
    
    Throws:
    
    IllegalArgumentException - if node is not contained in the cluster identified by clusterId.
    
    Since:
    
    JViews 3.0 This method replaces getIndex(IlvGraphic, IlvClusterId).
    
    See Also:
    
    setClusterId(Object, IlvClusterId, int), addClusterId(Object, IlvClusterId, int), removeClusterId(Object, IlvClusterId)
  - setClusteringMode
```
public final void setClusteringMode(int mode)
```
    Sets the clustering mode. Valid value are:
    - BY_CLUSTER_IDS - The information needed for dividing the graph into clusters is provided using IlvClusterId objects for all nodes.
      For each node of the graph, you must specify the cluster (that is, either the ring or the star) to which it belongs. Note that a node can belong to more than one cluster. To do this, you can use the methods setClusterId(Object, IlvClusterId) and addClusterId(Object, IlvClusterId). The class IlvClusterId is the abstract base class that is used as the identifier for the clusters. You can use one of its subclasses provided in JViews (IlvClusterName and IlvClusterNumber) or write your own subclass.
      
      In addition, for each cluster (ring or star), you can specify the order of the nodes along the cluster (with the exception of the central node for star clusters). To do this, you must use the methods setClusterId(Object, IlvClusterId, int) and addClusterId(Object, IlvClusterId, int), where the last argument is an integer index value associated with the node and the cluster. If the index values are provided, the layout algorithm places the nodes on the cluster in the order specified by the indexes.
      
      The position of the clusters is computed using a radial tree-like algorithm.
      
      Note that in this mode the initial position of the nodes (at the moment you start the layout) does not affect the resulting layout. However, nodes specified as fixed are not moved if you call the method IlvGraphLayout.setPreserveFixedNodes(boolean) with a true argument.
    - BY_SUBGRAPHS - The information needed for dividing the graph into clusters is provided by placing the nodes and links into subgraphs.
      In this mode, the algorithm handles a nested graph including intergraph links. It arranges the nodes of each subgraph on a circle, so that the number of link crossings is small. It respects the intergraph links and rotates the cluster so that the number of link crossings is small.
      
      It assumes that all nodes are nearly square, all nodes are in subgraphs, but the subgraph nesting is only 1. Nodes that are inside subgraphs of subgraphs are not anymore handles.
      
      Note that in this mode each subgraph keeps its initial position. The subgraphs can be placed either by a different layout algorithm, or interactively.
    - AUTOMATIC - This is similar to the mode BY_CLUSTER_IDS, but does not require any specification of clusters. The graph is divided into clusters by anaylizing the topology of the graph. Biconnected components form initial clusters. The remaining nodes that do not belong to any (nontrivial) biconnected component form star clusters if their degree is larger than the star cluster threshold. Then, the initial clusters are merged if they are smaller than the minimal size of a cluster, or split if they are larger than the maximal size of a cluster.
      You can specify clusters using IlvClusterId objects for some nodes, but it is not needed to specify it for all nodes. The class IlvClusterId is the abstract base class that is used as the identifier for the clusters. You can use one of its subclasses provided in JViews (IlvClusterName and IlvClusterNumber) or write your own subclass.
      
      In addition, for specified cluster (ring or star), you can optionally specify the order of the nodes along the cluster (with the exception of the central node for star clusters). To do this, you must use the methods setClusterId(Object, IlvClusterId, int) and addClusterId(Object, IlvClusterId, int), where the last argument is an integer index value associated with the node and the cluster. You can specify indexe for all or some nodes of the cluster. Nodes with specified index are placed in this relative order on the cluster. Nodes without specified index are merged into this relative order by using a heuristic to reduce the number of link crossings.
      
      The position of the clusters is computed using an instance of IlvTreeLayout.
    The default value is BY_CLUSTER_IDS .
    Since:
    
    JViews 5.5
    
    See Also:
    
    getClusteringMode()
  - getClusteringMode
```
public final int getClusteringMode()
```
    Returns the current clustering mode.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setClusteringMode(int)
  - setMaxNumberOfPermutations
```
public final void setMaxNumberOfPermutations(int n)
```
    Sets the maximum number of permutations tested for a cluster of more than 7 nodes. For smaller cluster, always all permutations are tested.
    This parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_SUBGRAPHS.
    
    The algorithm generates permutations of node orderings along the cluster circle and chooses the one with the best crossing and rotation behavior according to some quality criteria. Since the number of permutations is exponential, it is feasible to test all permutations only if there are no more than 7 nodes. Otherwise, the algorithm randomly generates some permutations and chooses the best one. The more permutations are chosen, the better the layout result.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getMaxNumberOfPermutations()
  - getMaxNumberOfPermutations
```
public final int getMaxNumberOfPermutations()
```
    Returns the maximum number of permutations tested for a cluster of more than 7 nodes.
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is BY_SUBGRAPHS.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setMaxNumberOfPermutations(int)
  - setInterClusterCrossingReduction
```
public final void setInterClusterCrossingReduction(boolean enable)
```
    Sets whether the crossing reduction takes inter cluster links into account. This is enabled by default.
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    isInterClusterCrossingReduction()
  - isInterClusterCrossingReduction
```
public final boolean isInterClusterCrossingReduction()
```
    Returns whether the crossing reduction takes inter cluster links into account.
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setInterClusterCrossingReduction(boolean)
  - setIntraClusterLinkCrossingPenalty
```
public final void setIntraClusterLinkCrossingPenalty(double penalty)
```
    Sets the penalty for crossings of links between nodes of the same cluster. These links are called intra cluster links.
    The default value is 1.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    During the crossing reduction, intra cluster links compete with inter cluster links, since some node orderings of a cluster produce more crossings of links inside the cluster, while other node orderings produce more crossings of links connecting different clusters. The penalty allows to fine tune whether intra cluster links or inter cluster links are more important.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getIntraClusterLinkCrossingPenalty()
  - getIntraClusterLinkCrossingPenalty
```
public final double getIntraClusterLinkCrossingPenalty()
```
    Returns the penalty for crossings of links between nodes of the same cluster. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setIntraClusterLinkCrossingPenalty(double)
  - setInterClusterLinkCrossingPenalty
```
public final void setInterClusterLinkCrossingPenalty(double penalty)
```
    Sets the penalty for crossings of links between nodes of different clusters. These links are called inter cluster links.
    The default value is 1.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    During the crossing reduction, intra cluster links compete with inter cluster links, since some node orderings of a cluster produce more crossings of links inside the cluster, while other node orderings produce more crossings of links connecting different clusters. The penalty allows to fine tune whether intra cluster links or inter cluster links are more important.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getInterClusterLinkCrossingPenalty()
  - getInterClusterLinkCrossingPenalty
```
public final double getInterClusterLinkCrossingPenalty()
```
    Returns the penalty for crossings of links between nodes of different cluster. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setInterClusterLinkCrossingPenalty(double)
  - setMixedClusterLinkCrossingPenalty
```
public final void setMixedClusterLinkCrossingPenalty(double penalty)
```
    Sets the penalty for crossings of intra cluster links with inter cluster links. Links between nodes of the same cluster are called intra cluster links, while links connecting different clusters are called inter cluster links.
    The default value is 1.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    During the crossing reduction, intra cluster links compete with inter cluster links, since some node orderings of a cluster produce more crossings of links inside the cluster, while other node orderings produce more crossings of links connecting different clusters. The penalty allows to fine tune whether intra cluster links or inter cluster links are more important.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getMixedClusterLinkCrossingPenalty()
  - getMixedClusterLinkCrossingPenalty
```
public final double getMixedClusterLinkCrossingPenalty()
```
    Returns the penalty for crossings of intra cluster links with inter cluster links. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setMixedClusterLinkCrossingPenalty(double)
  - setClusterByBiconnectivity
```
public final void setClusterByBiconnectivity(boolean enable)
```
    Sets whether the clustering by biconnectivity is enabled. It is enabled by default. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    If the graph is automatically clustered, sets of nodes that have many connections though links are transformed into clusters. The mathematical term is the biconnected component, a set of nodes that has so many connections so that removing one node or link still keeps the component connected. If clustering by biconnectivity is enabled, the biconnected components are the initial clusters. These might get furthermore split or merged if a minimal or maximal size per cluster is desired.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    isClusterByBiconnectivity(), setMinimumClusterSize(int), setMaximumClusterSize(int)
  - isClusterByBiconnectivity
```
public final boolean isClusterByBiconnectivity()
```
    Returns whether the clustering by biconnectivity is enabled. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setClusterByBiconnectivity(boolean)
  - setMinimumClusterSize
```
public final void setMinimumClusterSize(int size)
```
    Sets the minimum number of nodes to form a cluster. The value is obeyed for regular clusters, but not for star clusters.
    The default value is 4.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getMinimumClusterSize()
  - getMinimumClusterSize
```
public final int getMinimumClusterSize()
```
    Returns the minimum number of nodes to form a cluster. The value is obeyed for regular clusters, but not for star clusters. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setMinimumClusterSize(int)
  - setMaximumClusterSize
```
public final void setMaximumClusterSize(int size)
```
    Sets the maximum number of nodes to form a cluster. The value is obeyed for regular clusters, but not for star clusters. The value is only a hint. If the minimum and maximum cluster size are close, then the maximunm cluster size is sometimes not obeyed, in order to satisfy the minimum cluster size.
    The default value is 50.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getMaximumClusterSize()
  - getMaximumClusterSize
```
public final int getMaximumClusterSize()
```
    Returns the maximum number of nodes to form a cluster. The value is obeyed for regular clusters, but not for star clusters. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setMaximumClusterSize(int)
  - setHighDegreeStarClusterSize
```
public final void setHighDegreeStarClusterSize(int size)
```
    Sets the minimum size to create star clusters from nodes with high degree. The algorithm searches for nodes of high degree (high number of connected nodes) that are not yet clustered by biconnectivity. If the degree is at least the minimum size, it creates a star cluster with the high degree nodes as center of the cluster.
    The default value is 5.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getHighDegreeStarClusterSize()
  - getHighDegreeStarClusterSize
```
public final int getHighDegreeStarClusterSize()
```
    Returns the minimum size to create star clusters from nodes with high degree. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setHighDegreeStarClusterSize(int)
  - setMaximumNumberOfIterationsToReachMaxClusterSize
```
public final void setMaximumNumberOfIterationsToReachMaxClusterSize(int numIterations)
```
    Sets the number of iterations to achieve the maximum cluster size.
    The default value is 10.
    
    This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Splitting a cluster is an iterative process that tries to find good subclusters with only few links that run between different clusters. Initial subclusters are improved iteratively. If the cluster algorithm takes too much time, reducting the number of iterations speeds up the algorithm.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getMaximumNumberOfIterationsToReachMaxClusterSize()
  - getMaximumNumberOfIterationsToReachMaxClusterSize
```
public final int getMaximumNumberOfIterationsToReachMaxClusterSize()
```
    Returns the number of iterations to achieve the maximum cluster size. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setMaximumNumberOfIterationsToReachMaxClusterSize(int)
  - setLayoutOfClusterGraph
```
public void setLayoutOfClusterGraph(IlvGraphLayout layout)
```
    Returns the layout instance that lays out the graph of clusters. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    If a layout instance has been specified, this instance is used. If no layout instance has been specified, an instance of IlvTreeLayout is used. The tree layout is set to balloon layout mode. Note that the node comparator of the tree layout should not be set on this layout instance because it is modified at runtime (see customizeLayoutOfClusterGraph(ilog.views.graphlayout.IlvGraphLayout)). You can call this method with a null argument to return to the default tree layout instance.
    
    The layout instance cannot be used independently as long as it is set as a layout of the cluster graph.
    
    Parameters:
    
    layout - The layout instance to set, or null to use the default layout instance.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getLayoutOfClusterGraph()
  - getLayoutOfClusterGraph
```
public IlvGraphLayout getLayoutOfClusterGraph()
```
    Returns the layout instance that lays out the graph of clusters. This parameter is used only if the clustering mode (see setClusteringMode(int)) is AUTOMATIC.
    If a layout instance has been specified using the method setLayoutOfClusterGraph(IlvGraphLayout), this instance is returned. If no layout instance has been specified using the method setLayoutOfClusterGraph(IlvGraphLayout), the method returns an instance of IlvTreeLayout. The tree layout is set to balloon layout mode. Note that the node comparator of the tree layout should not be set on this layout instance because it is modified at runtime (see customizeLayoutOfClusterGraph(ilog.views.graphlayout.IlvGraphLayout)).
    Note that the layout instance returned by this method cannot be used independently as long as it is set as a layout of the cluster graph.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setLayoutOfClusterGraph(IlvGraphLayout)
  - customizeLayoutOfClusterGraph
```
protected void customizeLayoutOfClusterGraph(IlvGraphLayout layout)
                                      throws IlvGraphLayoutException
```
    Customize the layout of the cluster graph before it is applied. If getLayoutOfClusterGraph() returns a tree layout instance, it sets the node comparator to enforce an appropriate node ordering when laying out the graph of clusters. It also sets the global link style to IlvTreeLayout.NO_RESHAPE_STYLE since the links of the cluster graph are virtual links that don't need to be reshaped.
    
    Parameters:
    
    layout - The layout instance.
    
    Throws:
    
    IlvGraphLayoutException
    
    Since:
    
    JViews 8.7
  - supportsAllowedTime
```
public boolean supportsAllowedTime()
```
    Indicates that this layout class can not stop the layout computation when the user-defined allowed time is exceeded.
    
    Overrides:
    
    supportsAllowedTime in class IlvBasicLinkStyleLayout
    
    Returns:
    
    Always false.
    
    See Also:
    
    IlvGraphLayout.setAllowedTime(long), IlvGraphLayout.getAllowedTime(), IlvGraphLayoutReport.getCode()
  - supportsStopImmediately
```
public boolean supportsStopImmediately()
```
    Indicates that this layout class can interrupt the current run of the layout immediately in a controlled way.
    
    Overrides:
    
    supportsStopImmediately in class IlvBasicLinkStyleLayout
    
    Returns:
    
    Always false.
    
    See Also:
    
    IlvGraphLayout.stopImmediately(), IlvGraphLayout.isStoppedImmediately(), IlvGraphLayoutReport.getCode()
  - supportsLayoutRegion
```
public final boolean supportsLayoutRegion()
```
    Indicates that this layout class takes into account a user-defined region (a rectangle) or a user-defined manager view to compute the dimensions of the drawing.
    However, it is not possible to allow the user to control the size of the layout by specifying a bounding box for the drawing. The layout algorithm determines the size so that it has enough space to avoid overlapping nodes and clusters.
    
    The layout region setting (which is either your own or the default setting) is used only to determine the position of the center of the drawing. That means that only the center of the layout region is taken into consideration when performing the layout.
    
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS or AUTOMATIC.
    
    Overrides:
    
    supportsLayoutRegion in class IlvGraphLayout
    
    Returns:
    
    Always true.
    
    See Also:
    
    IlvGraphLayout.setLayoutRegion(ilog.views.IlvManagerView), IlvGraphLayout.setLayoutRegion(ilog.views.IlvManagerView, ilog.views.IlvRect), IlvGraphLayout.setLayoutRegion(ilog.views.IlvRect), IlvGraphLayout.getSpecLayoutRegion(), IlvGraphLayout.getCalcLayoutRegion()
  - supportsPercentageComplete
```
public boolean supportsPercentageComplete()
```
    Indicates that this layout class can not estimate the percentage of completion during the layout run.
    
    Overrides:
    
    supportsPercentageComplete in class IlvBasicLinkStyleLayout
    
    Returns:
    
    Always false.
    
    See Also:
    
    IlvGraphLayoutReport.getPercentageComplete()
  - setAreaMinimizationEnabled
```
public void setAreaMinimizationEnabled(boolean option)
```
    Sets whether the total area minimization option is enabled.
    If this option is enabled, priority is given to the readability of the layout. The child clusters are positioned closer to their parent clusters.
    
    If this option is disabled, the algorithm gives a higher priority to the minimization of the total area of the layout.
    
    The default value is false.
    
    Enabling the total area minimization is recommended for large graphs where the total area of the layout may become very large.
    
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    option - true to set area minimization priority, or false to set readability priority.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    isAreaMinimizationEnabled()
  - isAreaMinimizationEnabled
```
public boolean isAreaMinimizationEnabled()
```
    Returns whether total area minimization is enabled.
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    setAreaMinimizationEnabled(boolean)
  - setOffset
```
public void setOffset(double offsetValue)
```
    Sets the offset value. The Circular Layout algorithm tries to ensure that the minimum distance between two nodes is approximately equal to the offset value.
    The default value is 10.
    
    Parameters:
    
    offsetValue - The offset between two nodes.
    
    See Also:
    
    getOffset()
  - getOffset
```
public double getOffset()
```
    Returns the offset value.
    
    See Also:
    
    setOffset(double)
  - setLevelOffset
```
public void setLevelOffset(double offsetValue)
```
    Sets the offset between two concentric levels. This is an additional offset that is added to the minimum value computed by the layout algorithm to avoid overlapping clusters on the same level.
    The default value is zero.
    
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    offsetValue - The level offset value.
    
    See Also:
    
    getLevelOffset()
  - getLevelOffset
```
public double getLevelOffset()
```
    Returns the level offset value.
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    See Also:
    
    setLevelOffset(double)
  - setDisconnectedGraphOffset
```
public void setDisconnectedGraphOffset(double offsetValue)
```
    Sets the offset between disconnected groups of clusters (rings and/or stars). Disconnected groups of clusters are laid out in rows. This offset value represents the offset between the rows and the offset between groups on the same row.
    The default value is 10.
    
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    Parameters:
    
    offsetValue - The disconnected graph offset value.
    
    See Also:
    
    getDisconnectedGraphOffset()
  - getDisconnectedGraphOffset
```
public double getDisconnectedGraphOffset()
```
    Returns the offset between disconnected groups of clusters (rings and/or stars).
    Note that this parameter is only used if the clustering mode (see setClusteringMode(int)) is BY_CLUSTER_IDS.
    
    See Also:
    
    setDisconnectedGraphOffset(double)
  - createLayoutGrapherProperty
```
protected IlvGraphLayoutGrapherProperty createLayoutGrapherProperty(String name,
                                                                    boolean withDefaults)
```
    Returns a new instance of IlvCircularLayoutGrapherProperty that stores the parameter settings of this layout class.
    The method is used by IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean) to create a named property that contains parameter settings of this layout instance.
    
    Overrides:
    
    createLayoutGrapherProperty in class IlvBasicLinkStyleLayout
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    IlvGraphLayoutGrapherProperty, IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean), IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherAdapter.removeParametersFromNamedProperties()
  - createLayoutNodeProperty
```
protected IlvGraphLayoutNodeProperty createLayoutNodeProperty(String name,
                                                              IlvGraphic node,
                                                              boolean withDefaults)
```
    Returns a new instance of IlvCircularLayoutNodeProperty that stores the parameter settings of this layout class for nodes.
    The method is used by IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean) to create a named property for a node that contains parameter settings of this layout instance for the input node.
    
    Overrides:
    
    createLayoutNodeProperty in class IlvGraphLayout
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    IlvGraphLayoutNodeProperty, IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean), IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherAdapter.removeParametersFromNamedProperties()

Class IlvCircularLayout

Field Summary

Fields inherited from class ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout

Fields inherited from class ilog.views.graphlayout.IlvGraphLayout

Constructor Summary

Method Summary

Methods inherited from class ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout

Methods inherited from class ilog.views.graphlayout.IlvGraphLayout

Methods inherited from class java.lang.Object

Field Detail

NO_INDEX

BY_CLUSTER_IDS

BY_SUBGRAPHS

AUTOMATIC

STRAIGHT_LINE_STYLE

NO_RESHAPE_STYLE

Constructor Detail

IlvCircularLayout

IlvCircularLayout

Method Detail

copyParameters

init

copy

detach

internalLayout

setRootClusterId

removeRootClusterId

removeAllRootClusterIds

setRootClusterIds

getRootClusterIds

setStructureUpToDate

clusterize

setStarCenter

isStarCenter

setClusterId

setClusterId

addClusterId

addClusterId

removeClusterId

removeAllClusterIds

getClusterIds

getClusterRadius

getClusterCenter

getClusterNodes

getClusterIds

getClusterIdsCount

getIndex

setClusteringMode

getClusteringMode

setMaxNumberOfPermutations

getMaxNumberOfPermutations

setInterClusterCrossingReduction

isInterClusterCrossingReduction

setIntraClusterLinkCrossingPenalty

getIntraClusterLinkCrossingPenalty

setInterClusterLinkCrossingPenalty

getInterClusterLinkCrossingPenalty

setMixedClusterLinkCrossingPenalty

getMixedClusterLinkCrossingPenalty

setClusterByBiconnectivity

isClusterByBiconnectivity

setMinimumClusterSize

getMinimumClusterSize

setMaximumClusterSize

getMaximumClusterSize

setHighDegreeStarClusterSize

getHighDegreeStarClusterSize

setMaximumNumberOfIterationsToReachMaxClusterSize

getMaximumNumberOfIterationsToReachMaxClusterSize

setLayoutOfClusterGraph

getLayoutOfClusterGraph

customizeLayoutOfClusterGraph

supportsAllowedTime

supportsStopImmediately

supportsLayoutRegion

supportsPercentageComplete

setAreaMinimizationEnabled

isAreaMinimizationEnabled

setOffset

getOffset