y25.base
Interface GraphMap

All Superinterfaces:
DataAcceptor, DataProvider
All Known Implementing Classes:
LayeredGraph.GraphMapImpl

public interface GraphMap
extends DataProvider, DataAcceptor

Provides access to data associated with a graph. A graph map can be considered as a map that allows only graphs as keys. The graphs used as keys for the getter/setter methods must belong to the same layered graph.

The values bound to the graphs are initialized with Java(TM) default values(null, 0, 0.0, false) upon initialization.


Method Summary
 Object get(Object graph)
          Returns the value bound to the given graph.
 boolean getBool(Object graph)
          Returns the boolean value bound to the given graph.
 double getDouble(Object graph)
          Returns the double value bound to the given graph.
 int getInt(Object graph)
          Returns the integer value bound to the given graph.
 Object remove(Object graph)
          Removes the value stored for the given graph, if present.
 void set(Object graph, Object value)
          Associates the given value to the given graph.
 void setBool(Object graph, boolean value)
          Associates the given boolean value to the given graph.
 void setDouble(Object graph, double value)
          Associates the given double value to the given graph.
 void setInt(Object graph, int value)
          Associates the given integer value to the given graph.
 

Method Detail

remove

public Object remove(Object graph)
Removes the value stored for the given graph, if present. Returns the value that was previously stored for the graph, or null if there was no mapping for that graph. A null return can also mean that the map previously associated null with the given graph.


get

public Object get(Object graph)
Returns the value bound to the given graph. The value must have been assiciated to the given graph by a call to set.

Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to null.

Specified by:
get in interface DataProvider

getBool

public boolean getBool(Object graph)
Returns the boolean value bound to the given graph. The value must have been assiciated to the given graph by a call to setBool.

Returns false if the map contains no mapping for this key. A return value of false does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to false.

Specified by:
getBool in interface DataProvider

getDouble

public double getDouble(Object graph)
Returns the double value bound to the given graph. The value must have been assiciated to the given graph by a call to setDouble.

Returns 0.0 if the map contains no mapping for this key. A return value of 0.0 does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to 0.0.

Specified by:
getDouble in interface DataProvider

getInt

public int getInt(Object graph)
Returns the integer value bound to the given graph. The value must have been assiciated to the given graph by a call to setInt.

Returns 0 if the map contains no mapping for this key. A return value of 0 does not necessarily indicate that the map contains no mapping for the key; it is also possible that the map explicitly maps the key to 0.

Specified by:
getInt in interface DataProvider

set

public void set(Object graph,
                Object value)
Associates the given value to the given graph.

Specified by:
set in interface DataAcceptor

setBool

public void setBool(Object graph,
                    boolean value)
Associates the given boolean value to the given graph.

Specified by:
setBool in interface DataAcceptor

setDouble

public void setDouble(Object graph,
                      double value)
Associates the given double value to the given graph.

Specified by:
setDouble in interface DataAcceptor

setInt

public void setInt(Object graph,
                   int value)
Associates the given integer value to the given graph.

Specified by:
setInt in interface DataAcceptor