ds.funnel.overlay

Class OverlayPathImpl

java.lang.Object

ds.funnel.overlay.OverlayPathImpl

All Implemented Interfaces:

FormatMarshaller, FormatUnmarshaller<OverlayPath>, OverlayPath

public class OverlayPathImpl
extends java.lang.Object
implements OverlayPath

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<OverlayPath>	COMP_DIST
static java.util.Comparator<OverlayPath>	COMP_FLAT

Fields inherited from interface ds.funnel.overlay.OverlayPath

EMPTY_PATH, UNMARSHALL

Constructor Summary

Constructors

Constructor and Description
OverlayPathImpl(long inVersion, int... inLocation)

Method Summary

Modifier and Type	Method and Description
static int[]	between(OverlayPath treeLocA, OverlayPath treeLocB)
OverlayPath	branchPath(int inMemberId) Return a near copy of this path, adding an additional node.
OverlayPath	branchPath(long inVersion, int inMemberId) Return a near copy of this path, adding an additional node, and changing the overlay version.
int	distanceTo(OverlayPath inDestPath) The number of hops to reach the given destination using primary links.
boolean	equals(java.lang.Object inObj)
int	getNodeID()
int[]	getPath()
long	getVersion()
int	hashCode()
static int[]	longestPrefix(OverlayPath treeLocA, OverlayPath treeLocB)
void	marshall(FormatWriter mFormat)
boolean	onPathOf(OverlayPath inDestPath) True is this location is on the path of the given destination.
OverlayPath	returnPath() Reverse this path, creating a return routing path.
java.lang.String	toString()
OverlayPath	unmarshall(FormatReader mFormat)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMP_FLAT

public static final java.util.Comparator<OverlayPath> COMP_FLAT

COMP_DIST

public static final java.util.Comparator<OverlayPath> COMP_DIST

Constructor Detail

OverlayPathImpl

public OverlayPathImpl(long inVersion,
                       int... inLocation)

Method Detail

getVersion

public long getVersion()

Specified by:

getVersion in interface OverlayPath

Returns:

The version of the associated overlay.

getNodeID

public int getNodeID()

Specified by:

getNodeID in interface OverlayPath

Returns:

The IDs of the node specified by this path.

getPath

public int[] getPath()

Specified by:

getPath in interface OverlayPath

Returns:

An array of node IDs indicating the location of the node in the overlay. This is the the path from the coordinator using primary links.

onPathOf

public boolean onPathOf(OverlayPath inDestPath)

Description copied from interface: OverlayPath

True is this location is on the path of the given destination.

Specified by:

onPathOf in interface OverlayPath

Parameters:

inDestPath - - The destination location/path.

Returns:

True if this location is on the given path.

distanceTo

public int distanceTo(OverlayPath inDestPath)

Description copied from interface: OverlayPath

The number of hops to reach the given destination using primary links.

Specified by:

distanceTo in interface OverlayPath

Parameters:

inDestPath - - The destination location/path.

Returns:

The number of hops to reach the given destination.

branchPath

public OverlayPath branchPath(int inMemberId)

Description copied from interface: OverlayPath

Return a near copy of this path, adding an additional node. The overlay version remains the same.

Specified by:

branchPath in interface OverlayPath

Parameters:

inMemberId - - The node ID to add.

Returns:

The newly created path.

branchPath

public OverlayPath branchPath(long inVersion,
                              int inMemberId)

Description copied from interface: OverlayPath

Return a near copy of this path, adding an additional node, and changing the overlay version.

Specified by:

branchPath in interface OverlayPath

Parameters:

inVersion - - The overlay version to route using.

inMemberId - - The node ID to add.

Returns:

The newly created path.

returnPath

public OverlayPath returnPath()

Description copied from interface: OverlayPath

Reverse this path, creating a return routing path.

Specified by:

returnPath in interface OverlayPath

Returns:

The newly created return path.

equals

public boolean equals(java.lang.Object inObj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

marshall

public void marshall(FormatWriter mFormat)
              throws FormatException

Specified by:

marshall in interface FormatMarshaller

Parameters:

mFormat - - The format writer to write to

Throws:

FormatException - If there was a problem while writing

unmarshall

public OverlayPath unmarshall(FormatReader mFormat)
                       throws FormatException

Specified by:

unmarshall in interface FormatUnmarshaller<OverlayPath>

Parameters:

mFormat - - The format reader to read from

Returns:

An object read from the reader

Throws:

FormatException - If there was a problem while reading

longestPrefix

public static int[] longestPrefix(OverlayPath treeLocA,
                                  OverlayPath treeLocB)

between

public static int[] between(OverlayPath treeLocA,
                            OverlayPath treeLocB)