Module org.eclipse.persistence.core

Package org.eclipse.persistence.indirection

Class IndirectMap<K,V>

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<K,V>

org.eclipse.persistence.indirection.IndirectMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>, ChangeTracker, CollectionChangeTracker, IndirectCollection<Map.Entry<K,V>,Map<K,V>>, IndirectContainer<Map<K,V>>

public class IndirectMap<K,V>
extends Hashtable<K,V>
implements CollectionChangeTracker, IndirectCollection<Map.Entry<K,V>,Map<K,V>>

IndirectMap allows a domain class to take advantage of TopLink indirection without having to declare its instance variable as a ValueHolderInterface.

To use an IndirectMap:

• Declare the appropriate instance variable with type Map or Hashtable
• Send the message #useTransparentMap(String) to the appropriate CollectionMapping.

EclipseLink will place an IndirectMap in the instance variable when the containing domain object is read from the database. With the first message sent to the IndirectMap, the contents are fetched from the database and normal Hashtable/Map behavior is resumed.

Since:

TOPLink/Java 2.5

See Also:

• CollectionMapping
• IndirectList
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Hashtable<K,V>	delegate	Reduce type casting
protected int	initialCapacity	Store initial size for lazy init.
protected float	loadFactor	Store load factor for lazy init.
protected ValueHolderInterface<Map<K,V>>	valueHolder	Delegate indirection behavior to a value holder

Constructor Summary

Constructors

Constructor	Description
IndirectMap()	PUBLIC: Construct a new, empty IndirectMap with a default capacity and load factor.
IndirectMap(int initialCapacity)	PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and default load factor.
IndirectMap(int initialCapacity, float loadFactor)	PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and load factor.
IndirectMap(Map<? extends K,? extends V> m)	PUBLIC: Construct a new IndirectMap with the same mappings as the given Map.

Method Summary

Modifier and Type	Method	Description
PropertyChangeListener	_persistence_getPropertyChangeListener()	Return the property change listener for change tracking.
void	_persistence_setPropertyChangeListener(PropertyChangeListener changeListener)	INTERNAL: Set the property change listener for change tracking.
protected Hashtable<K,V>	buildDelegate()	Return the freshly-built delegate.
void	clear()
void	clearDeferredChanges()	INTERNAL: clear any changes that have been deferred to instantiation.
Object	clone()
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
boolean	contains(Object value)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Enumeration<V>	elements()
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super V> action)
V	get(Object key)
Collection<Map.Entry<K,V>>	getAddedElements()	INTERNAL: Return the elements that have been added before instantiation.
protected Hashtable<K,V>	getDelegate()	INTERNAL: Check whether the contents have been read from the database.
Map<K,V>	getDelegateObject()	INTERNAL: Return the real collection object.
V	getOrDefault(Object key, V defaultValue)
Collection<Map.Entry<K,V>>	getRemovedElements()	INTERNAL: Return the elements that have been removed before instantiation.
String	getTrackedAttributeName()	INTERNAL: Return the mapping attribute name, used to raise change events.
ValueHolderInterface<Map<K,V>>	getValueHolder()	PUBLIC: Return the valueHolder.
boolean	hasDeferredChanges()	INTERNAL: Return if any elements that have been added or removed before instantiation.
int	hashCode()
boolean	hasTrackedPropertyChangeListener()	INTERNAL: Return if the collection has a property change listener for change tracking.
protected void	initialize(int initialCapacity, float loadFactor)	Initialize the instance.
protected void	initialize(Map<? extends K,? extends V> m)	Initialize the instance.
boolean	isEmpty()
boolean	isInstantiated()	PUBLIC: Return whether the contents have been read from the database.
Enumeration<K>	keys()
Set<K>	keySet()
V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> t)
V	putIfAbsent(K key, V value)
protected void	raiseAddChangeEvent(Object key, Object value)	Raise the add change event and relationship maintainence.
protected void	raiseRemoveChangeEvent(Object key, Object value)	Raise the remove change event.
protected void	rehash()
V	remove(Object key)
boolean	remove(Object key, Object value)
V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	replaceAll(BiFunction<? super K,? super V,? extends V> function)
void	setTrackedAttributeName(String attributeName)	INTERNAL: Set the mapping attribute name, used to raise change events.
void	setUseLazyInstantiation(boolean useLazyInstantiation)	INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dB
void	setValueHolder(ValueHolderInterface<Map<K,V>> valueHolder)	INTERNAL: Set the value holder.
int	size()
String	toString()	PUBLIC: Use the Hashtable.toString(); but wrap it with braces to indicate there is a bit of indirection.
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Field Details

delegate

protected volatile Hashtable<K,V> delegate

Reduce type casting

valueHolder

protected volatile ValueHolderInterface<Map<K,V>> valueHolder

Delegate indirection behavior to a value holder

initialCapacity

protected int initialCapacity

Store initial size for lazy init.

loadFactor

protected float loadFactor

Store load factor for lazy init.

Constructor Details

IndirectMap

public IndirectMap()

PUBLIC: Construct a new, empty IndirectMap with a default capacity and load factor.

IndirectMap

public IndirectMap(int initialCapacity)

PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and default load factor.

Parameters:

initialCapacity - the initial capacity of the hashtable

IndirectMap

public IndirectMap(int initialCapacity,
 float loadFactor)

PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and load factor.

Parameters:

initialCapacity - the initial capacity of the hashtable

loadFactor - a number between 0.0 and 1.0

Throws:

IllegalArgumentException - if the initial capacity is less than or equal to zero, or if the load factor is less than or equal to zero

IndirectMap

public IndirectMap(Map<? extends K,? extends V> m)

PUBLIC: Construct a new IndirectMap with the same mappings as the given Map. The IndirectMap is created with a capacity of twice the number of entries in the given Map or 11 (whichever is greater), and a default load factor, which is 0.75.

Parameters:

m - a map containing the mappings to use

Method Details

buildDelegate

protected Hashtable<K,V> buildDelegate()

Return the freshly-built delegate.

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class Hashtable<K,V>

See Also:

• Hashtable.clear()

clearDeferredChanges

public void clearDeferredChanges()

INTERNAL: clear any changes that have been deferred to instantiation. Indirect collections with change tracking avoid instantiation on add/remove.

Specified by:

clearDeferredChanges in interface IndirectCollection<K,V>

clone

public Object clone()

Overrides:

clone in class Hashtable<K,V>

See Also:

• This will result in a database query if necessary.

contains

public boolean contains(Object value)

Overrides:

contains in class Hashtable<K,V>

See Also:

• Hashtable.contains(java.lang.Object)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class Hashtable<K,V>

See Also:

• Hashtable.containsKey(java.lang.Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class Hashtable<K,V>

See Also:

• Hashtable.containsValue(java.lang.Object)

elements

public Enumeration<V> elements()

Overrides:

elements in class Hashtable<K,V>

See Also:

• Hashtable.elements()

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Overrides:

entrySet in class Hashtable<K,V>

See Also:

• Hashtable.entrySet()

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Hashtable<K,V>

See Also:

• Hashtable.equals(java.lang.Object)

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class Hashtable<K,V>

See Also:

• Hashtable.get(java.lang.Object)

getDelegate

protected Hashtable<K,V> getDelegate()

INTERNAL: Check whether the contents have been read from the database. If they have not, read them and set the delegate. This method used to be synchronized, which caused deadlock.

getDelegateObject

public Map<K,V> getDelegateObject()

INTERNAL: Return the real collection object. This will force instantiation.

Specified by:

getDelegateObject in interface IndirectCollection<K,V>

getTrackedAttributeName

public String getTrackedAttributeName()

INTERNAL: Return the mapping attribute name, used to raise change events.

Specified by:

getTrackedAttributeName in interface CollectionChangeTracker

_persistence_getPropertyChangeListener

public PropertyChangeListener _persistence_getPropertyChangeListener()

Return the property change listener for change tracking.

Specified by:

_persistence_getPropertyChangeListener in interface ChangeTracker

getValueHolder

public ValueHolderInterface<Map<K,V>> getValueHolder()

PUBLIC: Return the valueHolder. This method used to be synchronized, which caused deadlock.

Specified by:

getValueHolder in interface IndirectContainer<K>

Returns:

org.eclipse.persistence.indirection.ValueHolderInterface A representation of the valueholder * which this container uses

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Hashtable<K,V>

See Also:

• Hashtable.hashCode()

hasTrackedPropertyChangeListener

public boolean hasTrackedPropertyChangeListener()

INTERNAL: Return if the collection has a property change listener for change tracking.

initialize

protected void initialize(int initialCapacity,
 float loadFactor)

Initialize the instance.

initialize

protected void initialize(Map<? extends K,? extends V> m)

Initialize the instance.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class Hashtable<K,V>

See Also:

• Hashtable.isEmpty()

isInstantiated

public boolean isInstantiated()

PUBLIC: Return whether the contents have been read from the database.

Specified by:

isInstantiated in interface IndirectContainer<K>

keys

public Enumeration<K> keys()

Overrides:

keys in class Hashtable<K,V>

See Also:

• Hashtable.keys()

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class Hashtable<K,V>

See Also:

• Hashtable.keySet()

put

public V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class Hashtable<K,V>

See Also:

• Hashtable.put(java.lang.Object, java.lang.Object)

putAll

public void putAll(Map<? extends K,? extends V> t)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class Hashtable<K,V>

See Also:

• Hashtable.putAll(java.util.Map)

compute

public V compute(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

compute in interface Map<K,V>

Overrides:

compute in class Hashtable<K,V>

computeIfAbsent

public V computeIfAbsent(K key,
 Function<? super K,? extends V> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K,V>

Overrides:

computeIfAbsent in class Hashtable<K,V>

computeIfPresent

public V computeIfPresent(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

computeIfPresent in interface Map<K,V>

Overrides:

computeIfPresent in class Hashtable<K,V>

forEach

public void forEach(BiConsumer<? super K,? super V> action)

Specified by:

forEach in interface Map<K,V>

Overrides:

forEach in class Hashtable<K,V>

getOrDefault

public V getOrDefault(Object key,
 V defaultValue)

Specified by:

getOrDefault in interface Map<K,V>

Overrides:

getOrDefault in class Hashtable<K,V>

merge

public V merge(K key,
 V value,
 BiFunction<? super V,? super V,? extends V> remappingFunction)

Specified by:

merge in interface Map<K,V>

Overrides:

merge in class Hashtable<K,V>

putIfAbsent

public V putIfAbsent(K key,
 V value)

Specified by:

putIfAbsent in interface Map<K,V>

Overrides:

putIfAbsent in class Hashtable<K,V>

remove

public boolean remove(Object key,
 Object value)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class Hashtable<K,V>

replace

public V replace(K key,
 V value)

Specified by:

replace in interface Map<K,V>

Overrides:

replace in class Hashtable<K,V>

replace

public boolean replace(K key,
 V oldValue,
 V newValue)

Specified by:

replace in interface Map<K,V>

Overrides:

replace in class Hashtable<K,V>

replaceAll

public void replaceAll(BiFunction<? super K,? super V,? extends V> function)

Specified by:

replaceAll in interface Map<K,V>

Overrides:

replaceAll in class Hashtable<K,V>

rehash

protected void rehash()

Overrides:

rehash in class Hashtable<K,V>

See Also:

• Hashtable.rehash()

raiseAddChangeEvent

protected void raiseAddChangeEvent(Object key,
 Object value)

Raise the add change event and relationship maintainence.

raiseRemoveChangeEvent

protected void raiseRemoveChangeEvent(Object key,
 Object value)

Raise the remove change event.

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class Hashtable<K,V>

See Also:

• Hashtable.remove(java.lang.Object)

setTrackedAttributeName

public void setTrackedAttributeName(String attributeName)

INTERNAL: Set the mapping attribute name, used to raise change events. This is required if the change listener is set.

Specified by:

setTrackedAttributeName in interface CollectionChangeTracker

_persistence_setPropertyChangeListener

public void _persistence_setPropertyChangeListener(PropertyChangeListener changeListener)

INTERNAL: Set the property change listener for change tracking.

Specified by:

_persistence_setPropertyChangeListener in interface ChangeTracker

setValueHolder

public void setValueHolder(ValueHolderInterface<Map<K,V>> valueHolder)

INTERNAL: Set the value holder.

Specified by:

setValueHolder in interface IndirectContainer<K>

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class Hashtable<K,V>

See Also:

• Hashtable.size()

setUseLazyInstantiation

public void setUseLazyInstantiation(boolean useLazyInstantiation)

INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dB

Specified by:

setUseLazyInstantiation in interface IndirectCollection<K,V>

getRemovedElements

public Collection<Map.Entry<K,V>> getRemovedElements()

INTERNAL: Return the elements that have been removed before instantiation.

Specified by:

getRemovedElements in interface IndirectCollection<K,V>

getAddedElements

public Collection<Map.Entry<K,V>> getAddedElements()

INTERNAL: Return the elements that have been added before instantiation.

Specified by:

getAddedElements in interface IndirectCollection<K,V>

hasDeferredChanges

public boolean hasDeferredChanges()

INTERNAL: Return if any elements that have been added or removed before instantiation.

Specified by:

hasDeferredChanges in interface IndirectCollection<K,V>

toString

public String toString()

PUBLIC: Use the Hashtable.toString(); but wrap it with braces to indicate there is a bit of indirection. Don't allow this method to trigger a database read.

Overrides:

toString in class Hashtable<K,V>

See Also:

• Hashtable.toString()

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Overrides:

values in class Hashtable<K,V>

See Also:

• Hashtable.values()