com.soteradefense.dga.hbse

Class PathData

java.lang.Object

com.soteradefense.dga.hbse.PathData

All Implemented Interfaces:

Writable

public class PathData
extends Object
implements Writable

Message that can be passed between vertices. Used for both shortest path computation and pair dependency accumulation. Some fields are only used in one of the two phases, or take on different meaning in the different phases.

For more information on this method of calculation betweenness centrality see "U. Brandes, A Faster Algorithm for Betweenness Centrality"

Constructor Summary

Constructors

Constructor and Description
PathData() The Default Constructor for PathData: Sets Distance to the Max long value. Sets source to -1. Sets from to -1. Sets dependency to -1. Sets numPaths to -1.

Method Summary

Methods

Modifier and Type	Method and Description
double	getDependency() Gets the dependency value.
static PathData	getDependencyMessage(String source, double dependency, long numPaths) Get a new PathData message for accumulating pair dependency values
long	getDistance() Gets the distance from source to a predecessor.
String	getFrom() Gets the predecessor/successor value.
long	getNumPaths() Gets the number of shortest paths.
static PathData	getPingMessage(String source) Get a new PathData message for sending successor / predecessor information to neighbors
static PathData	getShortestPathMessage(String source, String from, long distance, long numPaths) Get a new PathData message for shortest path computation.
String	getSource() Gets the source value.
void	readFields(DataInput in)
void	setDependency(double dependency) Sets the dependency value.
void	setDistance(long distance) Sets the distance from a source to a predecessor.
void	setFrom(String from) Sets the value of from.
void	setNumPaths(long numPaths) Set the number of paths.
void	setSource(String source) Sets the source value.
void	write(DataOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PathData

public PathData()

The Default Constructor for PathData:

• Sets Distance to the Max long value.
• Sets source to -1.
• Sets from to -1.
• Sets dependency to -1.
• Sets numPaths to -1.

Method Detail

getShortestPathMessage

public static PathData getShortestPathMessage(String source,
                              String from,
                              long distance,
                              long numPaths)

Get a new PathData message for shortest path computation.

Parameters:

source - The source Id

from - The predecessor Id.

distance - The distance from the source to the predecessor.

numPaths - The number of paths from source to the predecessor.

Returns:

a New PathData Object

getPingMessage

public static PathData getPingMessage(String source)

Get a new PathData message for sending successor / predecessor information to neighbors

Parameters:

source - The source that the ping came from.

Returns:

A new PathData message for Ping purposes.

getDependencyMessage

public static PathData getDependencyMessage(String source,
                            double dependency,
                            long numPaths)

Get a new PathData message for accumulating pair dependency values

Parameters:

source - The source that the ping came from.

dependency - The pair dependency value.

numPaths - The number of shortest paths.

Returns:

A new PathData for a Dependency Message.

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface Writable

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface Writable

Throws:

IOException

getDistance

public long getDistance()

Gets the distance from source to a predecessor.

Returns:

The distance value.

setDistance

public void setDistance(long distance)

Sets the distance from a source to a predecessor.

Parameters:

distance - Distance value to set it to.

getSource

public String getSource()

Gets the source value.

Returns:

The source value.

setSource

public void setSource(String source)

Sets the source value.

Parameters:

source - The value to set the source to.

getFrom

public String getFrom()

Gets the predecessor/successor value.

Returns:

The value of from.

setFrom

public void setFrom(String from)

Sets the value of from.

Parameters:

from - The value to set from to.

getDependency

public double getDependency()

Gets the dependency value.

Returns:

The value in dependency.

setDependency

public void setDependency(double dependency)

Sets the dependency value.

Parameters:

dependency - The value to set dependency to.

getNumPaths

public long getNumPaths()

Gets the number of shortest paths.

Returns:

The value in numPaths.

setNumPaths

public void setNumPaths(long numPaths)

Set the number of paths.

Parameters:

numPaths - The value to set numPaths to.