edu.uci.ics.jung.io.graphml
Class KeyMap

java.lang.Object
  edu.uci.ics.jung.io.graphml.KeyMap

public class KeyMap
extends Object

A KeyMap is a storage mechanism for the keys read from the GraphML file. It stores the keys indexed by the type of GraphML metadata (node, edge, etc) that the key applies to. The applyKeys method will obtain the list of keys that apply to the given metadata type and apply the keys one-by-one to the metadata.

Author:

Nathan Mittler - nathan.mittler@gmail.com

Constructor Summary

KeyMap()

Method Summary

void	addKey(Key key) Adds the given key to the map.
void	applyKeys(Metadata metadata) Applies all keys that are applicable to the given metadata.
void	clear() Clears this map.
Set<Map.Entry<Metadata.MetadataType,List<Key>>>	entrySet() Retrieves the set of entries contained in this map.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyMap

public KeyMap()

Method Detail

addKey

public void addKey(Key key)

Adds the given key to the map.

Parameters:

key - the key to be added.

applyKeys

public void applyKeys(Metadata metadata)

Applies all keys that are applicable to the given metadata.

Parameters:

metadata - the target metadata.

clear

public void clear()

Clears this map.

entrySet

public Set<Map.Entry<Metadata.MetadataType,List<Key>>> entrySet()

Retrieves the set of entries contained in this map.

Returns:

all of the entries in this map.