oracle.toplink.essentials.internal.queryframework

Class MapContainerPolicy

java.lang.Object

oracle.toplink.essentials.internal.queryframework.ContainerPolicy

oracle.toplink.essentials.internal.queryframework.InterfaceContainerPolicy

oracle.toplink.essentials.internal.queryframework.MapContainerPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MapContainerPolicy
extends InterfaceContainerPolicy

Purpose: A MapContainerPolicy is ContainerPolicy whose container class implements the Map interface.

Responsibilities: Provide the functionality to operate on an instance of a Map.

See Also:

ContainerPolicy, CollectionContainerPolicy, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class	elementClass
protected java.lang.String	elementClassName
protected java.lang.reflect.Field	keyField
protected java.lang.reflect.Method	keyMethod
protected java.lang.String	keyName

Fields inherited from class oracle.toplink.essentials.internal.queryframework.InterfaceContainerPolicy

cloneMethod, containerClass, containerClassName

Fields inherited from class oracle.toplink.essentials.internal.queryframework.ContainerPolicy

constructor, elementDescriptor

Constructor Summary

Constructors

Constructor and Description
MapContainerPolicy() INTERNAL: Construct a new policy.
MapContainerPolicy(java.lang.Class containerClass) INTERNAL: Construct a new policy for the specified class.
MapContainerPolicy(java.lang.String containerClassName) INTERNAL: Construct a new policy for the specified class name.

Method Summary

Modifier and Type	Method and Description
boolean	addInto(java.lang.Object key, java.lang.Object element, java.lang.Object container, AbstractSession session) INTERNAL: Add element into container which implements the Map interface.
void	clear(java.lang.Object container) INTERNAL: Remove all the elements from container.
boolean	compareKeys(java.lang.Object sourceValue, AbstractSession session) INTERNAL: Return true if keys are the same in the source as the backup.
protected boolean	contains(java.lang.Object element, java.lang.Object container) INTERNAL: Return the true if element exists in container.
void	convertClassNamesToClasses(java.lang.ClassLoader classLoader) INTERNAL: Convert all the class-name-based settings in this ContainerPolicy to actual class-based settings.
java.lang.Class	getElementClass() INTERNAL: Returns the element class which defines the map key.
java.lang.String	getElementClassName() INTERNAL: Returns the element class name which defines the map key.
java.lang.Class	getInterfaceType() INTERNAL:
java.lang.String	getKeyName() INTERNAL: Returns the key name which will return the value of the key to be used in the container.
boolean	isMapPolicy() INTERNAL Yes this is a MapPolicy
boolean	isValidContainer(java.lang.Object container) INTERNAL: Validate the container type.
java.lang.Object	iteratorFor(java.lang.Object container) INTERNAL: Return an Iterator for the given container.
java.lang.Object	keyFrom(java.lang.Object element, AbstractSession session) INTERNAL: Return the key for the specified element.
void	prepare(DatabaseQuery query, AbstractSession session) Prepare and validate.
boolean	removeFrom(java.lang.Object key, java.lang.Object element, java.lang.Object container, AbstractSession session) INTERNAL: Remove element from container which implements the Map interface.
boolean	removeFromWithIdentity(java.lang.Object element, java.lang.Object container, AbstractSession session) INTERNAL: Remove element from container which implements the Map interface.
void	setElementClass(java.lang.Class elementClass) INTERNAL: Sets the element class which defines the method.
void	setKeyName(java.lang.String keyName) INTERNAL: Sets the key name to be used to generate the key in a Map type container class.
void	setKeyName(java.lang.String keyName, java.lang.String elementClassName) INTERNAL: Sets the key name to be used to generate the key in a Map type container class.
int	sizeFor(java.lang.Object container) INTERNAL: Return the size of container.
void	validateElementAndRehashIfRequired(java.lang.Object sourceValue, java.lang.Object targetMap, AbstractSession session, java.lang.Object targetVersionOfSource) INTERNAL: If the key has changed, remove the element and add it back into the target.

Methods inherited from class oracle.toplink.essentials.internal.queryframework.InterfaceContainerPolicy

cloneFor, getCloneMethod, getCloneMethod, getContainerClass, getContainerClassName, hasNext, invokeCloneMethodOn, isValidContainerType, next, setCloneMethod, setContainerClass, setContainerClassName, toStringInfo

Methods inherited from class oracle.toplink.essentials.internal.queryframework.ContainerPolicy

addInto, addInto, addIntoWithOrder, addIntoWithOrder, addIntoWithOrder, buildContainerFromVector, buildPolicyFor, buildPolicyFor, clone, clone, compareCollectionsForChange, concatenateContainers, containerInstance, containerInstance, contains, containsKey, execute, getConstructor, getElementDescriptor, hasElementDescriptor, hasOrder, initializeConstructor, isCollectionPolicy, isCursoredStreamPolicy, isCursorPolicy, isCursorStreamPolicy, isDirectMapPolicy, isEmpty, isListPolicy, isScrollableCursorPolicy, mergeCascadeParts, mergeChanges, next, overridesRead, prepareForExecution, recordAddToCollectionInChangeRecord, recordRemoveFromCollectionInChangeRecord, remoteExecute, removeAllElements, removeFrom, removeFrom, removeFromWithOrder, setConstructor, setElementDescriptor, toString, vectorFor

Methods inherited from class java.lang.Object

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

Field Detail

keyName

protected java.lang.String keyName

elementClassName

protected java.lang.String elementClassName

elementClass

protected java.lang.Class elementClass

keyField

protected transient java.lang.reflect.Field keyField

keyMethod

protected transient java.lang.reflect.Method keyMethod

Constructor Detail

MapContainerPolicy

public MapContainerPolicy()

INTERNAL: Construct a new policy.

MapContainerPolicy

public MapContainerPolicy(java.lang.Class containerClass)

INTERNAL: Construct a new policy for the specified class.

MapContainerPolicy

public MapContainerPolicy(java.lang.String containerClassName)

INTERNAL: Construct a new policy for the specified class name.

Method Detail

prepare

public void prepare(DatabaseQuery query,
                    AbstractSession session)
             throws QueryException

Prepare and validate. Set the element class.

Overrides:

prepare in class ContainerPolicy

Throws:

QueryException

addInto

public boolean addInto(java.lang.Object key,
                       java.lang.Object element,
                       java.lang.Object container,
                       AbstractSession session)

INTERNAL: Add element into container which implements the Map interface.

Overrides:

addInto in class ContainerPolicy

clear

public void clear(java.lang.Object container)

INTERNAL: Remove all the elements from container.

Overrides:

clear in class ContainerPolicy

compareKeys

public boolean compareKeys(java.lang.Object sourceValue,
                           AbstractSession session)

INTERNAL: Return true if keys are the same in the source as the backup. False otherwise in the case of readonly compare against the original

Overrides:

compareKeys in class ContainerPolicy

contains

protected boolean contains(java.lang.Object element,
                           java.lang.Object container)

INTERNAL: Return the true if element exists in container.

Overrides:

contains in class ContainerPolicy

Returns:

boolean true if container 'contains' element

convertClassNamesToClasses

public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)

INTERNAL: Convert all the class-name-based settings in this ContainerPolicy to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.

Overrides:

convertClassNamesToClasses in class InterfaceContainerPolicy

Parameters:

classLoader -

getElementClass

public java.lang.Class getElementClass()

INTERNAL: Returns the element class which defines the map key.

getElementClassName

public java.lang.String getElementClassName()

INTERNAL: Returns the element class name which defines the map key.

getInterfaceType

public java.lang.Class getInterfaceType()

INTERNAL:

Specified by:

getInterfaceType in class InterfaceContainerPolicy

getKeyName

public java.lang.String getKeyName()

INTERNAL: Returns the key name which will return the value of the key to be used in the container.

isMapPolicy

public boolean isMapPolicy()

INTERNAL Yes this is a MapPolicy

Overrides:

isMapPolicy in class ContainerPolicy

iteratorFor

public java.lang.Object iteratorFor(java.lang.Object container)

INTERNAL: Return an Iterator for the given container.

Specified by:

iteratorFor in class ContainerPolicy

See Also:

ContainerPolicy.hasNext(java.lang.Object), ContainerPolicy.next(java.lang.Object)

keyFrom

public java.lang.Object keyFrom(java.lang.Object element,
                                AbstractSession session)

INTERNAL: Return the key for the specified element.

Overrides:

keyFrom in class ContainerPolicy

Parameters:

element - java.lang.Object

Returns:

java.lang.Object

removeFrom

public boolean removeFrom(java.lang.Object key,
                          java.lang.Object element,
                          java.lang.Object container,
                          AbstractSession session)

INTERNAL: Remove element from container which implements the Map interface.

Overrides:

removeFrom in class ContainerPolicy

removeFromWithIdentity

public boolean removeFromWithIdentity(java.lang.Object element,
                                      java.lang.Object container,
                                      AbstractSession session)

INTERNAL: Remove element from container which implements the Map interface.

setElementClass

public void setElementClass(java.lang.Class elementClass)

INTERNAL: Sets the element class which defines the method.

isValidContainer

public boolean isValidContainer(java.lang.Object container)

INTERNAL: Validate the container type.

Overrides:

isValidContainer in class ContainerPolicy

See Also:

CollectionContainerPolicy.isValidContainer(Object), isValidContainer(Object)

setKeyName

public void setKeyName(java.lang.String keyName,
                       java.lang.String elementClassName)

INTERNAL: Sets the key name to be used to generate the key in a Map type container class. The key name, may be the name of a field or method.

Overrides:

setKeyName in class ContainerPolicy

See Also:

#MapContainerPolicy

setKeyName

public void setKeyName(java.lang.String keyName)

INTERNAL: Sets the key name to be used to generate the key in a Map type container class. The key name, maybe the name of a field or method.

sizeFor

public int sizeFor(java.lang.Object container)

INTERNAL: Return the size of container.

Overrides:

sizeFor in class ContainerPolicy

validateElementAndRehashIfRequired

public void validateElementAndRehashIfRequired(java.lang.Object sourceValue,
                                               java.lang.Object targetMap,
                                               AbstractSession session,
                                               java.lang.Object targetVersionOfSource)

INTERNAL: If the key has changed, remove the element and add it back into the target.

Overrides:

validateElementAndRehashIfRequired in class ContainerPolicy