byucc.edif
Class EdifNameSpaceMap<E extends NamedPropertyObject>

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<K,V>
          java.util.LinkedHashMap<java.lang.String,E>
              byucc.edif.EdifNameSpaceMap<E>

All Implemented Interfaces:

EdifNameSpace<E>, Trimable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Map<java.lang.String,E>

public class EdifNameSpaceMap<E extends NamedPropertyObject>
extends java.util.LinkedHashMap<java.lang.String,E>
implements EdifNameSpace<E>, java.lang.Iterable<E>

A map implementation of the EdifNameSpace interface.

Version:

$Id: EdifNameSpaceMap.java,v 1.11 2006/08/23 21:17:51 jonjohn Exp $

See Also:

Serialized Form

Field Summary

private java.util.HashMap<java.lang.String,E>	_oldNameToElement Used to map from old names to elements contained in the map for faster lookup.
private EdifNameSpaceUtils	_util Contains methods common to all EdifNameSpace implementations.

Constructor Summary

EdifNameSpaceMap(EdifNameClashPolicy clashPolicy)
Construct an EdifNameSpaceMap with the given EdifNameClashPolicy.

EdifNameSpaceMap(EdifNameClashPolicy clashPolicy, int size)
Construct an EdifNameSpaceMap with the given EdifNameClashPolicy and size.

Method Summary

void	addElement(E element) Add an EdifNameable object to the name space.
boolean	contains(E element) Indicate whether the given EdifNameable object is a member of the name space.
boolean	containsNew(java.lang.String str) Indicate whether the name space contains a new name (part of a RenamedObject) that matches the given string.
boolean	containsOld(java.lang.String str) Indicate whether the name space contains an old name (part of a RenamedObject) that matches the given string.
boolean	containsSingle(java.lang.String str) Indicate whether the name space contains a single name (as a NamedObject) that matches the given string.
E	get(java.lang.String str) Return the Nameable object associated with this name space that matches the given String name.
E	getOld(java.lang.String str)
EdifNameable	getUniqueNameable(E element) Determine a name based on the name of the given element that will not clash with any names already in the name space.
EdifNameable	getUniqueNameable(EdifNameable en) Determine a name based on the given name that will not clash with any names already in the name space.
java.util.Iterator<E>	iterator() Return an Iterator for all Nameable objects in the name space
boolean	nameClash(E element) Determine if the given elements name will clash with the names already in the name space.
boolean	nameClash(EdifNameable en) Determine if the given name will clash with the names in this given EdifNameSpace.
boolean	remove(E element) Remove an object of type E from the name space
void	trimToSize() This method is used to trim the size of all "trimable" data structures within the Object.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface byucc.edif.EdifNameSpace

size

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

_util

private EdifNameSpaceUtils _util

Contains methods common to all EdifNameSpace implementations.

_oldNameToElement

private java.util.HashMap<java.lang.String,E extends NamedPropertyObject> _oldNameToElement

Used to map from old names to elements contained in the map for faster lookup.

Constructor Detail

EdifNameSpaceMap

public EdifNameSpaceMap(EdifNameClashPolicy clashPolicy)

Construct an EdifNameSpaceMap with the given EdifNameClashPolicy.

Parameters:

clashPolicy - the clash policy to use for determining if two names clash

EdifNameSpaceMap

public EdifNameSpaceMap(EdifNameClashPolicy clashPolicy,
                        int size)

Construct an EdifNameSpaceMap with the given EdifNameClashPolicy and size.

Parameters:

clashPolicy - the clash policy to use for determining if two names clash

size - the original size of the list

Method Detail

addElement

public void addElement(E element)
                throws EdifNameConflictException

Description copied from interface: EdifNameSpace

Add an EdifNameable object to the name space. This method will check to see if there is a conflict and throw an exception if there is a conflict.

Specified by:

addElement in interface EdifNameSpace<E extends NamedPropertyObject>

Throws:

EdifNameConflictException - This exception is thrown when a name conflict occurs during the add.

contains

public boolean contains(E element)

Description copied from interface: EdifNameSpace

Indicate whether the given EdifNameable object is a member of the name space. The search is performed using the name of the object.

Specified by:

contains in interface EdifNameSpace<E extends NamedPropertyObject>

Returns:

true if the object is a member of the space. false if it is not a member of the space.

get

public E get(java.lang.String str)

Description copied from interface: EdifNameSpace

Return the Nameable object associated with this name space that matches the given String name.

Specified by:

get in interface EdifNameSpace<E extends NamedPropertyObject>

Returns:

The Nameable object within this name space. This will return a null if an object of the given name does not exist.

getOld

public E getOld(java.lang.String str)

getUniqueNameable

public EdifNameable getUniqueNameable(E element)

Description copied from interface: EdifNameSpace

Determine a name based on the name of the given element that will not clash with any names already in the name space.

Specified by:

getUniqueNameable in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

element - the element whose name will be used as a basis for a unique name

Returns:

a unique name

getUniqueNameable

public EdifNameable getUniqueNameable(EdifNameable en)

Description copied from interface: EdifNameSpace

Determine a name based on the given name that will not clash with any names already in the name space.

Specified by:

getUniqueNameable in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

en - the name to use as a basis for a unique name.

Returns:

a unique name

iterator

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

Description copied from interface: EdifNameSpace

Return an Iterator for all Nameable objects in the name space

Specified by:

iterator in interface EdifNameSpace<E extends NamedPropertyObject>

Specified by:

iterator in interface java.lang.Iterable<E extends NamedPropertyObject>

Returns:

Iterator over all Nameable objects in the name space.

nameClash

public boolean nameClash(E element)

Description copied from interface: EdifNameSpace

Determine if the given elements name will clash with the names already in the name space.

Specified by:

nameClash in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

element - the element whose name will be compared with the name space

Returns:

a boolean indicating whether there will be a clash

nameClash

public boolean nameClash(EdifNameable en)

Description copied from interface: EdifNameSpace

Determine if the given name will clash with the names in this given EdifNameSpace.

Specified by:

nameClash in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

en - the name that will be compared with the name space

Returns:

a boolean indicating whether there will be a clash

containsNew

public boolean containsNew(java.lang.String str)

Description copied from interface: EdifNameSpace

Indicate whether the name space contains a new name (part of a RenamedObject) that matches the given string.

Specified by:

containsNew in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

str - the string to match against

Returns:

a boolean indicating whether a match was found

containsOld

public boolean containsOld(java.lang.String str)

Description copied from interface: EdifNameSpace

Indicate whether the name space contains an old name (part of a RenamedObject) that matches the given string.

Specified by:

containsOld in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

str - the string to match against

Returns:

a boolean indicating whether a match was found

containsSingle

public boolean containsSingle(java.lang.String str)

Description copied from interface: EdifNameSpace

Indicate whether the name space contains a single name (as a NamedObject) that matches the given string.

Specified by:

containsSingle in interface EdifNameSpace<E extends NamedPropertyObject>

Parameters:

str - the string to match against

Returns:

a boolean indicating whether a match was found

remove

public boolean remove(E element)

Remove an object of type E from the name space

Returns:

true if the object was successfully removed from the name spce

trimToSize

public void trimToSize()

Description copied from interface: Trimable

This method is used to trim the size of all "trimable" data structures within the Object. This method often involves the "trimToSize" method provided by many of the standard Java Collection data structures.

Specified by:

trimToSize in interface Trimable