ilog.views.graphlayout.circular

Class IlvClusterId

java.lang.Object

ilog.views.graphlayout.circular.IlvClusterId

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvClusterName, IlvClusterNumber

public abstract class IlvClusterId
extends Object
implements Serializable, IlvPersistentObject

The base class of the objects that are used to identify clusters. You can use one of its subclasses provided in this package or you can write your own subclasses.

Note that this class implements the IlvPersistentObject interface. The implementation of the method write does nothing. If you write a subclass of IlvClusterId that needs to be persistent, you must create a constructor with the signature MyClusterId(IlvInputStream stream) so that it can be read by IlvInputStream, and you must override the method write to write the attributes of the cluster identifier.

Since:

JViews 2.0

See Also:

IlvCircularLayout.setClusterId(Object, IlvClusterId, int), IlvCircularLayout.addClusterId(Object, IlvClusterId, int), IlvClusterNumber, IlvClusterName, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvClusterId() Creates a new IlvClusterId.

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(Object obj) Compares the IlvClusterId to the specified object.
abstract int	hashCode() Returns a hash code for the cluster identifier.
abstract String	toString() Returns a string representation of the cluster identifier.
void	write(IlvOutputStream stream) Writes the cluster identifier to an IlvOutputStream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvClusterId

public IlvClusterId()

Creates a new IlvClusterId.

Method Detail

hashCode

public abstract int hashCode()

Returns a hash code for the cluster identifier.

Overrides:

hashCode in class Object

Returns:

a hash code value for the cluster identifier.

See Also:

Object.hashCode()

equals

public abstract boolean equals(Object obj)

Compares the IlvClusterId to the specified object. The result must be true if and only if the argument is not null and both cluster identifiers represent the same cluster.

Overrides:

equals in class Object

Parameters:

obj - The object with which to compare the IlvClusterId

Returns:

true if the IlvClusterId are equal; false otherwise.

toString

public abstract String toString()

Returns a string representation of the cluster identifier.

Overrides:

toString in class Object

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the cluster identifier to an IlvOutputStream. The current implementation does nothing.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.