structure
Class Table<K extends java.lang.Comparable<K>,V>

java.lang.Object
  structure.AbstractMap<K,V>
      structure.Table<K,V>

All Implemented Interfaces:

Map<K,V>, OrderedMap<K,V>

public class Table<K extends java.lang.Comparable<K>,V>
extends AbstractMap<K,V>
implements OrderedMap<K,V>

An implementation of an ordered dictionary. Key-value pairs are kept in the structure in order. To accomplish this, the keys of the table must be comparable.

Example Usage:

To create an alphebetized dictionary by reading a collection of words and definitions from System.in we could use the following:

 public static void main (String[] argv){
        OrderedMap dict = new Table();
        ReadStream r = new ReadStream();
        String word, def;
        System.out.println("Enter a word: ");
        while(!r.eof()){
            word = r.readLine();
            System.out.println("Enter a definition: ");
            def = r.readLine();
            dict.put(word,def);
            System.out.println("Enter a word: ");
        }
        System.out.println(dict);
 }
 

See Also:

Comparable

Constructor Summary

Table()
Construct a new, empty table.

Table(Table other)

Method Summary

void	clear() Remove all the elements of the table.
boolean	containsKey(K key) Determine if the key is in the table.
boolean	containsValue(V value) Returns true if the value is associated with some key in the table.
Set<Association<K,V>>	entrySet() Return a structure containing all the entries in this Table
V	get(K key) Retrieve the value associated with the key provided.
boolean	isEmpty() Determine if the table is empty.
java.util.Iterator<V>	iterator() Construct an iterator over the values of the table.
java.util.Iterator<K>	keys() Construct an iterator over the keys of the table.
Set<K>	keySet() Return a set containing the keys referenced by this data structure.
static void	main(java.lang.String[] argv)
V	put(K key, V value) Enter a key-value pair into the table.
V	remove(K key) Remove a key-value pair, based on key.
int	size() Determine the number of key-value pairs within the table.
java.lang.String	toString() Construct a string representing value of table.
Structure<V>	values() Return a structure containing all the values referenced by this data structure.

Methods inherited from class structure.AbstractMap

hashCode, putAll

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface structure.Map

equals, hashCode, putAll

Constructor Detail

Table

public Table()

Construct a new, empty table.

Post:

constructs a new table

Table

public Table(Table other)

Method Detail

get

public V get(K key)

Retrieve the value associated with the key provided. Be aware, the value may be null.

Specified by:

get in interface Map<K extends java.lang.Comparable<K>,V>

Parameters:

key - The key of the key-value pair sought.

Returns:

The value associated with the key.

Pre:

key is a non-null object

Post:

returns value associated with key, or null

put

public V put(K key,
             V value)

Enter a key-value pair into the table. if the key is already in the table, the old value is returned, and the old key-value pair is replaced. Otherwise null is returned. The user is cautioned that a null value returned may indicate there was no prior key-value pair, or --- if null values are inserted --- that the key was previously associated with a null value.

Specified by:

put in interface Map<K extends java.lang.Comparable<K>,V>

Parameters:

key - The unique key in the table.

value - The (possibly null) value associated with key.

Returns:

The prior value, or null if no prior value found.

Pre:

key is non-null object

Post:

key-value pair is added to table

isEmpty

public boolean isEmpty()

Determine if the table is empty.

Specified by:

isEmpty in interface Map<K extends java.lang.Comparable<K>,V>

Returns:

True iff the table has no elements.

Post:

returns true iff table is empty

clear

public void clear()

Remove all the elements of the table.

Specified by:

clear in interface Map<K extends java.lang.Comparable<K>,V>

Post:

removes all elements from the table

keys

public java.util.Iterator<K> keys()

Construct an iterator over the keys of the table. The order of the keys returned is in ascending order. It will be consistent with that of the iterator from elements, provided the table is not modified.

Returns:

An iterator over the keys of the table.

Post:

returns an iterator for traversing keys of table

iterator

public java.util.Iterator<V> iterator()

Construct an iterator over the values of the table. The order of the values returned is determined by order of keys. It will be consistent with that of the iterator returned from keys, provided the table is not modified.

Returns:

An iterator over the values of the table.

Post:

returns an iterator for traversing values in table

containsKey

public boolean containsKey(K key)

Determine if the key is in the table. The key should not be null.

Specified by:

containsKey in interface Map<K extends java.lang.Comparable<K>,V>

Parameters:

key - A non-null key sought in the table.

Returns:

True iff the key is used in association with some value.

Pre:

key is non-null object

Post:

returns true iff key indexes a value in table

containsValue

public boolean containsValue(V value)

Returns true if the value is associated with some key in the table. This is often difficult to implement efficiently.

Specified by:

containsValue in interface Map<K extends java.lang.Comparable<K>,V>

Parameters:

value - The value sought (possibly null).

Returns:

True, if the value is associated with some key in table.

Pre:

value is non-null object

Post:

returns true iff value in table

remove

public V remove(K key)

Remove a key-value pair, based on key. The value is returned.

Specified by:

remove in interface Map<K extends java.lang.Comparable<K>,V>

Parameters:

key - The key of the key-value pair to be removed.

Returns:

The value associated with key, no longer in table.

Pre:

key is non-null object

Post:

removes value indexed in table

size

public int size()

Determine the number of key-value pairs within the table.

Specified by:

size in interface Map<K extends java.lang.Comparable<K>,V>

Returns:

The number of key-value pairs in the table.

Post:

returns number of key-value pairs in table

keySet

public Set<K> keySet()

Return a set containing the keys referenced by this data structure.

Specified by:

keySet in interface Map<K extends java.lang.Comparable<K>,V>

Returns:

a set containing the key referenced by this data structure.

Post:

Returns a set containing the keys referenced by this data structure.

values

public Structure<V> values()

Return a structure containing all the values referenced by this data structure.

Specified by:

values in interface Map<K extends java.lang.Comparable<K>,V>

Returns:

a structure containing all the values referenced by this data structure.

Post:

Returns a structure containing all the values referenced by this data structure.

entrySet

public Set<Association<K,V>> entrySet()

Return a structure containing all the entries in this Table

Specified by:

entrySet in interface Map<K extends java.lang.Comparable<K>,V>

Returns:

a structure containing all the entries in this Table

Post:

Returns a structure containing all the entries in this Table

toString

public java.lang.String toString()

Construct a string representing value of table.

Overrides:

toString in class java.lang.Object

Returns:

String representing table.

Post:

returns string representation

main

public static void main(java.lang.String[] argv)