IBM ILOG Dojo Diagrammer 1.1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.graphlayout.circular.CircularClusterId

Object » ibm_ilog.graphlayout.circular.CircularClusterId
dojo.require("ibm_ilog.graphlayout.circular.CircularClusterId");

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 PersistentObject interface. The implementation of the method write does nothing. If you write a subclass of ClusterId that needs to be persistent, you must create a constructor with the signature MyClusterId(InputStream stream) so that it can be read by InputStream, and you must override the method write to write the attributes of the cluster identifier.

Method Summary

  • constructor()
  • equals(obj) Compares the 'ClusterId' to the specified object.
  • hashCode() Returns a hash code for the cluster identifier.
  • toString() Returns a string representation of the cluster identifier.

Methods

constructor
equals
'true' if the 'ClusterId' are equal; 'false' otherwise.

Compares the ClusterId 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.

ParameterTypeDescription
objObjectThe object with which to compare the 'ClusterId'
hashCode
a hash code value for the cluster identifier.

Returns a hash code for the cluster identifier.

toString
Returns a string representation of the cluster identifier.