org.isam.exehda
Class CellId

java.lang.Object
  |
  +--org.isam.exehda.HierarchicalId
        |
        +--org.isam.exehda.CellId
All Implemented Interfaces:
java.io.Serializable

public final class CellId
extends HierarchicalId

System-wide unique cell identifier. All cell identifiers are root ID's, so unicity depends on the local id. Thus, the cell name assigment policy must guarantee that assigned names for each cell in the system are unique. A sugested scheme that would satisfy such condition is to derive the cell name from the organization's Internet domain name.

Version:
$Date: 2004/12/16 19:46:23 $ $Revision: 1.1 $
Author:
last modified by $Author: lucc $
See Also:
Serialized Form

Constructor Summary
(package private) CellId(java.lang.String cellName)
          Creates a new CellId instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Implements HierarchicalId equality semantics.
protected  java.lang.Object getLocalId()
          Returns the local id, which in the case of this class corresponds to the cell's name.
 java.lang.String getName()
          Returns the cell's name.
protected  java.lang.String getType()
          Returns a String representation of the CellId type (actually, the value "cell").
 int hashCode()
          Implements the hash code semantics for HierarchicalId objects so that those object would be used as keys in a java.util Hashtable.
 
Methods inherited from class org.isam.exehda.HierarchicalId
getParentId, isRoot, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CellId

CellId(java.lang.String cellName)
Creates a new CellId instance.

Parameters:
cellName - the name of the cell whose id is being created.
Method Detail

equals

public boolean equals(java.lang.Object o)
Description copied from class: HierarchicalId
Implements HierarchicalId equality semantics. Two HierarchicalIds are said to be equal if the equality holds for their local IDs, types and parent IDs respectively. This is a reference implementation. Subclasses are highly encouraged to overwrite this method with faster (optimized) implementations.

Overrides:
equals in class HierarchicalId
Parameters:
o - an Object value
Returns:
true if the given object is equals to this object, false otherwise.

hashCode

public int hashCode()
Description copied from class: HierarchicalId
Implements the hash code semantics for HierarchicalId objects so that those object would be used as keys in a java.util Hashtable. This is a reference implementation. Subclasses are highly encouraged to overwrite this method with faster (optimized) implementations.

Overrides:
hashCode in class HierarchicalId
Returns:
a hash code for this object

getName

public java.lang.String getName()
Returns the cell's name.

Returns:
a string value representing the cell's name.

getType

protected final java.lang.String getType()
Returns a String representation of the CellId type (actually, the value "cell").

Specified by:
getType in class HierarchicalId
Returns:
the string "cell".

getLocalId

protected final java.lang.Object getLocalId()
Returns the local id, which in the case of this class corresponds to the cell's name.

Specified by:
getLocalId in class HierarchicalId
Returns:
the cell name