com.yworks.yfiles.algorithms

Interface IEdgeMap

All Superinterfaces:

IDataAcceptor, IDataMap, IDataProvider

public interface IEdgeMap
extends IDataProvider, IDataAcceptor, IDataMap

Provides access to data associated with an edge.

An edge map can be considered as a map that allows only edges as keys. Edge keys of an edge map must belong to the same graph.

There are data access methods defined for the most common typed values as well.

The edge values are initialized with Java(TM) default values (null, 0, 0.0, false) upon initialization.

Method Summary

Modifier and Type	Method and Description
Object	get(Object edge) Returns the value bound to the given edge.
boolean	getBool(Object edge) Returns the boolean value bound to the given edge.
double	getDouble(Object edge) Returns the double value bound to the given edge.
int	getInt(Object edge) Returns the integer value bound to the given edge.
void	set(Object edge, Object value) Associates the given value to the given edge.
void	setBool(Object edge, boolean value) Associates the given boolean value to the given edge.
void	setDouble(Object edge, double value) Associates the given double value to the given edge.
void	setInt(Object edge, int value) Associates the given integer value to the given edge.

Method Detail

get

Object get(Object edge)

Returns the value bound to the given edge.

Specified by:

get in interface IDataProvider

getBool

boolean getBool(Object edge)

Returns the boolean value bound to the given edge.

Specified by:

getBool in interface IDataProvider

Precondition:

The value must have been associated to the given edge by a call to setBool.

getDouble

double getDouble(Object edge)

Returns the double value bound to the given edge.

Specified by:

getDouble in interface IDataProvider

Precondition:

The value must have been associated to the given edge by a call to setDouble.

getInt

int getInt(Object edge)

Returns the integer value bound to the given edge.

Specified by:

getInt in interface IDataProvider

Precondition:

The value must have been associated to the given edge by a call to setInt.

set

void set(Object edge,
         Object value)

Associates the given value to the given edge.

Specified by:

set in interface IDataAcceptor

setBool

void setBool(Object edge,
             boolean value)

Associates the given boolean value to the given edge.

Specified by:

setBool in interface IDataAcceptor

setDouble

void setDouble(Object edge,
               double value)

Associates the given double value to the given edge.

Specified by:

setDouble in interface IDataAcceptor

setInt

void setInt(Object edge,
            int value)

Associates the given integer value to the given edge.

Specified by:

setInt in interface IDataAcceptor