oracle.toplink.essentials.internal.ejb.cmp3.base

Class CMP3Policy

java.lang.Object

oracle.toplink.essentials.descriptors.CMPPolicy

oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy

All Implemented Interfaces:

java.io.Serializable

public class CMP3Policy
extends CMPPolicy

Description: Defines primary key extraction coce, and differentiates CMP3 from CMP1/2.

Since:

TopLink 10.1.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy.KeyElementAccessor[]	keyClassFields Stores the fields for this classes compound primary key class if required.
protected java.lang.Class	pkClass
protected java.lang.String	pkClassName

Fields inherited from class oracle.toplink.essentials.descriptors.CMPPolicy

descriptor

Constructor Summary

Constructors

Constructor and Description
CMP3Policy()

Method Summary

Modifier and Type	Method and Description
void	convertClassNamesToClasses(java.lang.ClassLoader classLoader) INTERNAL: Convert all the class-name-based settings in this object to actual class-based settings.
protected java.lang.Object	createBeanUsingKey(java.lang.Object key, AbstractSession session) INTERNAL: Use the key to create a bean and initialize its primary key fields.
java.util.Vector	createPkVectorFromKey(java.lang.Object key, AbstractSession session) INTERNAL: Use the key to create a TopLink primary key Vector.
java.lang.Object	createPrimaryKeyInstance(java.lang.Object key, AbstractSession session) INTERNAL: Create an instance of the composite primary key class for the key object.
protected oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy.KeyElementAccessor[]	getKeyClassFields(java.lang.Class clazz) INTERNAL:
java.lang.Class	getPKClass() INTERNAL:
java.lang.Object	getPKClassInstance() INTERNAL:
java.lang.String	getPKClassName() INTERNAL:
protected oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy.KeyElementAccessor[]	initializePrimaryKeyFields(java.lang.Class keyClass) INTERNAL: Cache the bean's primary key fields so speed up creating of primary key objects and initialization of beans.
boolean	isCMP3Policy() INTERNAL: Return if this policy is for CMP3.
void	setPKClass(java.lang.Class pkClass) ADVANCED:
void	setPrimaryKeyClassName(java.lang.String pkClassName) INTERNAL:

Methods inherited from class oracle.toplink.essentials.descriptors.CMPPolicy

getDescriptor, initialize, setDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

keyClassFields

protected oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy.KeyElementAccessor[] keyClassFields

Stores the fields for this classes compound primary key class if required.

pkClassName

protected java.lang.String pkClassName

pkClass

protected java.lang.Class pkClass

Constructor Detail

CMP3Policy

public CMP3Policy()

Method Detail

convertClassNamesToClasses

public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)

INTERNAL: Convert all the class-name-based settings in this object 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 CMPPolicy

Parameters:

classLoader -

isCMP3Policy

public boolean isCMP3Policy()

INTERNAL: Return if this policy is for CMP3.

Overrides:

isCMP3Policy in class CMPPolicy

setPrimaryKeyClassName

public void setPrimaryKeyClassName(java.lang.String pkClassName)

INTERNAL:

getPKClass

public java.lang.Class getPKClass()

INTERNAL:

setPKClass

public void setPKClass(java.lang.Class pkClass)

ADVANCED:

getPKClassName

public java.lang.String getPKClassName()

INTERNAL:

getPKClassInstance

public java.lang.Object getPKClassInstance()

INTERNAL:

createPkVectorFromKey

public java.util.Vector createPkVectorFromKey(java.lang.Object key,
                                              AbstractSession session)

INTERNAL: Use the key to create a TopLink primary key Vector. If the key is simple (direct mapped) then just add it to a vector, otherwise must go through the inefficient process of copying the key into the bean and extracting the key from the bean.

Parameters:

key - Object the primary key to use for creating the vector

Returns:

Vector

createPrimaryKeyInstance

public java.lang.Object createPrimaryKeyInstance(java.lang.Object key,
                                                 AbstractSession session)

INTERNAL: Create an instance of the composite primary key class for the key object.

createBeanUsingKey

protected java.lang.Object createBeanUsingKey(java.lang.Object key,
                                              AbstractSession session)

INTERNAL: Use the key to create a bean and initialize its primary key fields. Note: If is a compound PK then a primary key object is being used. This method should only be used for 'templates' when executing queries. The bean built will not be given an EntityContext and should not be used as an actual entity bean.

Parameters:

key - Object the primary key to use for initializing the bean's corresponding pk fields

Returns:

TopLinkCmpEntity

initializePrimaryKeyFields

protected oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy.KeyElementAccessor[] initializePrimaryKeyFields(java.lang.Class keyClass)

INTERNAL: Cache the bean's primary key fields so speed up creating of primary key objects and initialization of beans. Note, we have to re-look up the fields for the bean class since these fields may have been loaded with the wrong loader (thank you Kirk). If the key is compound, we also have to look up the fields for the key.

getKeyClassFields

protected oracle.toplink.essentials.internal.ejb.cmp3.base.CMP3Policy.KeyElementAccessor[] getKeyClassFields(java.lang.Class clazz)

INTERNAL:

Returns:

Returns the keyClassFields.