ilog.views.graphlayout.circular

Class IlvClusterInfoProperty

java.lang.Object

ilog.views.IlvNamedProperty

ilog.views.graphlayout.circular.IlvClusterInfoProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvClusterInfoProperty
extends IlvNamedProperty

This class allows you to store, for each node of an IlvGrapher, the identifiers of the clusters to which the node belongs and the corresponding indexes of the node on each cluster. A boolean value that corresponds to the "star center" attribute of the node is also stored. This class can be used to implement the persistence of the clustering information for the Circular Layout algorithm. (See the class IlvCircularLayout.)

Since this class extends IlvNamedProperty, the attribute values stored by an instance of IlvClusterInfoProperty are automatically saved in the .ivl file if they are attached to a graphic object using the method setNamedProperty.

Since:

JViews 2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME A default name of the property.

Constructor Summary

Constructors

Constructor and Description
IlvClusterInfoProperty(IlvClusterId[] clusterIds, int[] indexes, boolean isStarCenter) Creates a new IlvClusterInfoProperty.
IlvClusterInfoProperty(IlvClusterInfoProperty source) Creates a new IlvClusterInfoProperty by copying an existing one.
IlvClusterInfoProperty(IlvInputStream stream) Creates a new IlvClusterInfoProperty from an IlvInputStream.
IlvClusterInfoProperty(String name, IlvClusterId[] clusterIds, int[] indexes, boolean isStarCenter) Creates a new IlvClusterInfoProperty.

Method Summary

Modifier and Type	Method and Description
IlvNamedProperty	copy() Copies the property.
IlvClusterId[]	getClusterIds() Returns the array of cluster identifiers stored in the property.
int[]	getIndexes() Returns the array of indexes stored in the property
boolean	isPersistent() Indicates if the property must be saved to the .ivl file.
boolean	isStarCenter() Returns the value of the "star center" attribute stored in the property.
void	setPersistent(boolean persistent) Specifies whether the property must be saved in the .ivl file.
void	write(IlvOutputStream stream) Writes the property to an IlvOutputStream.

Methods inherited from class ilog.views.IlvNamedProperty

getName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

A default name of the property.

See Also:

Constant Field Values

Constructor Detail

IlvClusterInfoProperty

public IlvClusterInfoProperty(IlvClusterId[] clusterIds,
                              int[] indexes,
                              boolean isStarCenter)

Creates a new IlvClusterInfoProperty. The default name stored in the variable NAME is used.

Parameters:

clusterIds - The identifiers of the cluster to which a node belongs

indexes - the corresponding indexes of the node on each cluster

isStarCenter - If true, the node is the center of a star cluster

Throws:

IllegalArgumentException - If the arrays of cluster identifiers and indexes have different lengths.

IlvClusterInfoProperty

public IlvClusterInfoProperty(String name,
                              IlvClusterId[] clusterIds,
                              int[] indexes,
                              boolean isStarCenter)

Creates a new IlvClusterInfoProperty.

Parameters:

name - the name of the property

clusterIds - the identifiers of the cluster to which a node belongs

indexes - the corresponding indexes of the node on each cluster

isStarCenter - if true, the node is the center of a star cluster

Throws:

IllegalArgumentException - if the arrays of cluster identifiers and indexes have different lengths.

IlvClusterInfoProperty

public IlvClusterInfoProperty(IlvClusterInfoProperty source)

Creates a new IlvClusterInfoProperty by copying an existing one.

Parameters:

source - the origin of the copy.

IlvClusterInfoProperty

public IlvClusterInfoProperty(IlvInputStream stream)
                       throws IlvReadFileException

Creates a new IlvClusterInfoProperty from an IlvInputStream.

Parameters:

stream - the input stream

Throws:

IlvReadFileException - if an error occurs while reading.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the property to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvNamedProperty

Parameters:

stream - the output stream.

Throws:

IOException - standard IO error.

copy

public IlvNamedProperty copy()

Copies the property.

Specified by:

copy in class IlvNamedProperty

setPersistent

public void setPersistent(boolean persistent)

Specifies whether the property must be saved in the .ivl file. By default, the property is persistent.

Parameters:

persistent - true if the property must be saved in an .ivl file, and false otherwise.

isPersistent

public boolean isPersistent()

Indicates if the property must be saved to the .ivl file.

Specified by:

isPersistent in class IlvNamedProperty

getClusterIds

public IlvClusterId[] getClusterIds()

Returns the array of cluster identifiers stored in the property.

getIndexes

public int[] getIndexes()

Returns the array of indexes stored in the property

isStarCenter

public boolean isStarCenter()

Returns the value of the "star center" attribute stored in the property.