Module datarush.commons

Package com.pervasive.datarush.cal

Class VirtualNodeID

java.lang.Object

com.pervasive.datarush.cal.VirtualNodeID

All Implemented Interfaces:

Serializable, Comparable<VirtualNodeID>

public final class VirtualNodeID
extends Object
implements Serializable, Comparable<VirtualNodeID>

Identifies a "virtual node" in a cluster. In DataRush terms, a virtual node is a pipeline. A virtual node consists of the following components:

1. type: the type of virtual node. may be a worker, client, or master
2. physical ID: this is the node id of an actual machine in the cluster. Will be null for pseudo-distributed nodes.
3. offset: an offset within the physical node.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static VirtualNodeID	MASTER	The virtual node of type VirtualNodeType.MASTER.

Method Summary

Modifier and Type	Method	Description
int	compareTo(VirtualNodeID o)
boolean	equals(Object obj)
static VirtualNodeID	forDistributedWorker(String physicalNodeID, int offset)	Creates a distributed worker node id
static VirtualNodeID	forPseudoDistributedWorker(int offset)	Creates a pseudo-distributed worker node id
String	getID()	Returns the unique id.
int	getOffset()	Returns the offset within the physical node.
String	getPhysicalNodeID()	Returns the physical node on which this virtual node resides.
VirtualNodeType	getType()	Returns the type of this node
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MASTER

public static final VirtualNodeID MASTER

The virtual node of type VirtualNodeType.MASTER. Has no physical node id or offset.

Method Detail

forPseudoDistributedWorker

public static VirtualNodeID forPseudoDistributedWorker(int offset)

Creates a pseudo-distributed worker node id

Parameters:

offset - the offset

Returns:

a new pseudo-distributed worker node id

forDistributedWorker

public static VirtualNodeID forDistributedWorker(String physicalNodeID,
                                                 int offset)

Creates a distributed worker node id

Parameters:

physicalNodeID - the worker physical node id

offset - the offset

Returns:

a new distributed worker node id

getID

public String getID()

Returns the unique id. This will be one of the following forms:

1. client
2. embedded
3. master-physicalid
4. worker-physicalid-offset

Returns:

the unique id

getType

public VirtualNodeType getType()

Returns the type of this node

Returns:

the type of this node

getPhysicalNodeID

public String getPhysicalNodeID()

Returns the physical node on which this virtual node resides.

Returns:

the physical node on which this virtual node resides.

getOffset

public int getOffset()

Returns the offset within the physical node.

Returns:

the offset within the physical node.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(VirtualNodeID o)

Specified by:

compareTo in interface Comparable<VirtualNodeID>