Modifier and Type	Class and Description
private abstract static class	CMP3Policy.CommonAccessor
private static class	CMP3Policy.FieldAccessor INTERNAL: This class will be used when the element of the keyclass is a field
private static class	CMP3Policy.PropertyAccessor INTERNAL: This class is used when the key class element is a property
private static class	CMP3Policy.ValuesFieldAccessor INTERNAL: This class will be used when the element of the keyclass is a virtual field.

Modifier and Type	Field and Description
protected transient HashMap<DatabaseField, CMPPolicy.KeyElementAccessor>	fieldToAccessorMap Used to look up the KeyElementAccessor for a specific DatabaseField, used for resolving DerivedIds
protected transient CMPPolicy.KeyElementAccessor[]	keyClassFields Stores the fields for this classes compound primary key class if required.
protected Class<?>	pkClass
protected String	pkClassName

Access	Constructor and Description
public	CMP3Policy()

Method Summary

Modifier and Type	Method and Description
protected void	addReadOnlyMappings(ClassDescriptor aDescriptor, DatabaseField field, List<E> allMappings) INTERNAL: Add the writable mapping for the given field to the allMappings list.
protected void	addWritableMapping(ClassDescriptor aDescriptor, DatabaseField field, List<E> allMappings) INTERNAL: Add the read only mappings for the given field to the allMappings list.
public CMP3Policy	clone() Overrides org.eclipse.persistence.descriptors.CMPPolicy.clone. INTERNAL: Clone the CMP3Policy
public void	convertClassNamesToClasses(ClassLoader classLoader) Overrides org.eclipse.persistence.descriptors.CMPPolicy.convertClassNamesToClasses. INTERNAL: Convert all the class-name-based settings in this object to actual class-based settings.
public Object	Returns: Object createBeanUsingKey(Object Object the primary key to use for initializing the bean's corresponding pk fields key, AbstractSession session) Overrides org.eclipse.persistence.descriptors.CMPPolicy.createBeanUsingKey. INTERNAL: Use the key to create a bean and initialize its primary key fields.
public Object	createPrimaryKeyFromId(Object key, AbstractSession session) Overrides org.eclipse.persistence.descriptors.CMPPolicy.createPrimaryKeyFromId. INTERNAL: Use the key to create a EclipseLink primary key.
protected Field	Returns: the field from the class with name equal to fieldName. getField(Class<?> cls, String fieldName) INTERNAL:
protected CMPPolicy.KeyElementAccessor[]	Returns: Returns the keyClassFields. getKeyClassFields() Overrides org.eclipse.persistence.descriptors.CMPPolicy.getKeyClassFields. INTERNAL:
public <T> Class<T>	getPKClass() Overrides org.eclipse.persistence.descriptors.CMPPolicy.getPKClass. INTERNAL: Return the java Class representing the primary key class name
public Object	getPKClassInstance() Overrides org.eclipse.persistence.descriptors.CMPPolicy.getPKClassInstance. INTERNAL:
public String	getPKClassName() INTERNAL:
public Object	Returns: Object getPkValueFromKeyForField(Object Object the primary key to use to get the value for the field key, DatabaseField DatabaseField the field to find a value for field, AbstractSession session) INTERNAL: Pull the value for the field from the key.
public void	initialize(ClassDescriptor descriptor, AbstractSession session) Overrides org.eclipse.persistence.descriptors.CMPPolicy.initialize. INTERNAL: Initialize the CMPPolicy settings.
protected CMPPolicy.KeyElementAccessor[]	initializePrimaryKeyFields(Class<?> keyClass, AbstractSession session) INTERNAL: Cache the bean's primary key fields so speed up creating of primary key objects and initialization of beans.
public boolean	isCMP3Policy() Overrides org.eclipse.persistence.descriptors.CMPPolicy.isCMP3Policy. INTERNAL: Return if this policy is for CMP3.
public void	remoteInitialize(ClassDescriptor descriptor, AbstractSession session) Overrides org.eclipse.persistence.descriptors.CMPPolicy.remoteInitialize. INTERNAL: Initialize the CMPPolicy settings for remote sessions.
public void	setPKClass(Class<?> pkClass) ADVANCED:
public void	setPrimaryKeyClassName(String pkClassName) INTERNAL:

Field Detail

fieldToAccessorMap	back to summary
protected transient HashMap<DatabaseField, CMPPolicy.KeyElementAccessor> fieldToAccessorMap Used to look up the KeyElementAccessor for a specific DatabaseField, used for resolving DerivedIds

keyClassFields	back to summary
protected transient CMPPolicy.KeyElementAccessor[] keyClassFields Stores the fields for this classes compound primary key class if required.

pkClass	back to summary
protected Class<?> pkClass

pkClassName	back to summary
protected String pkClassName

Constructor Detail

CMP3Policy	back to summary
public CMP3Policy()

Method Detail

addReadOnlyMappings	back to summary
protected void addReadOnlyMappings(ClassDescriptor aDescriptor, DatabaseField field, List<E> allMappings) INTERNAL: Add the writable mapping for the given field to the allMappings list.

addWritableMapping	back to summary
protected void addWritableMapping(ClassDescriptor aDescriptor, DatabaseField field, List<E> allMappings) INTERNAL: Add the read only mappings for the given field to the allMappings list.

clone	back to summary
public CMP3Policy clone() Overrides org.eclipse.persistence.descriptors.CMPPolicy.clone. INTERNAL: Clone the CMP3Policy Returns:CMP3Policy Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public CMP3Policy clone()

Overrides org.eclipse.persistence.descriptors.CMPPolicy.clone.

INTERNAL: Clone the CMP3Policy

Returns:CMP3Policy

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

convertClassNamesToClasses	back to summary
public void convertClassNamesToClasses(ClassLoader classLoader) Overrides org.eclipse.persistence.descriptors.CMPPolicy.convertClassNamesToClasses. 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. Annotations @Override

convertClassNamesToClasses

back to summary

public void convertClassNamesToClasses(ClassLoader classLoader)

Overrides org.eclipse.persistence.descriptors.CMPPolicy.convertClassNamesToClasses.

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.

Annotations

@Override

createBeanUsingKey	back to summary
public Object createBeanUsingKey(Object key, AbstractSession session) Overrides org.eclipse.persistence.descriptors.CMPPolicy.createBeanUsingKey. 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 Object the primary key to use for initializing the bean's corresponding pk fields Returns:Object Object Annotations @Override

createBeanUsingKey

back to summary

public Object createBeanUsingKey(Object key, AbstractSession session)

Overrides org.eclipse.persistence.descriptors.CMPPolicy.createBeanUsingKey.

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: Object the primary key to use for initializing the bean's corresponding pk fields

Returns:Object

Object

Annotations

@Override

createPrimaryKeyFromId	back to summary
public Object createPrimaryKeyFromId(Object key, AbstractSession session) Overrides org.eclipse.persistence.descriptors.CMPPolicy.createPrimaryKeyFromId. INTERNAL: Use the key to create a EclipseLink primary key. 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. Annotations @Override

createPrimaryKeyFromId

back to summary

public Object createPrimaryKeyFromId(Object key, AbstractSession session)

Overrides org.eclipse.persistence.descriptors.CMPPolicy.createPrimaryKeyFromId.

INTERNAL: Use the key to create a EclipseLink primary key. 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.

Annotations

@Override

getField	back to summary
protected Field getField(Class<?> cls, String fieldName) throws NoSuchFieldException INTERNAL: Returns:Field the field from the class with name equal to fieldName.

getField

back to summary

protected Field getField(Class<?> cls, String fieldName) throws NoSuchFieldException

INTERNAL:

Returns:Field: the field from the class with name equal to fieldName.

getKeyClassFields	back to summary
protected CMPPolicy.KeyElementAccessor[] getKeyClassFields() Overrides org.eclipse.persistence.descriptors.CMPPolicy.getKeyClassFields. INTERNAL: Returns:CMPPolicy.KeyElementAccessor[] Returns the keyClassFields. Annotations @Override

getKeyClassFields

back to summary

protected CMPPolicy.KeyElementAccessor[] getKeyClassFields()

Overrides org.eclipse.persistence.descriptors.CMPPolicy.getKeyClassFields.

INTERNAL:

Returns:CMPPolicy.KeyElementAccessor[]

Returns the keyClassFields.

Annotations

@Override

getPKClass	back to summary
public <T> Class<T> getPKClass() Overrides org.eclipse.persistence.descriptors.CMPPolicy.getPKClass. INTERNAL: Return the java Class representing the primary key class name Annotations @Override @SuppressWarnings:unchecked

getPKClass

back to summary

public <T> Class<T> getPKClass()

Overrides org.eclipse.persistence.descriptors.CMPPolicy.getPKClass.

INTERNAL: Return the java Class representing the primary key class name

Annotations

@Override
@SuppressWarnings:unchecked

getPKClassInstance	back to summary
public Object getPKClassInstance() Overrides org.eclipse.persistence.descriptors.CMPPolicy.getPKClassInstance. INTERNAL: Annotations @Override

getPKClassInstance

back to summary

public Object getPKClassInstance()

Overrides org.eclipse.persistence.descriptors.CMPPolicy.getPKClassInstance.

INTERNAL:

Annotations

@Override

getPKClassName	back to summary
public String getPKClassName() INTERNAL:

getPkValueFromKeyForField	back to summary
public Object getPkValueFromKeyForField(Object key, DatabaseField field, AbstractSession session) INTERNAL: Pull the value for the field from the key. Parameters key:Object Object the primary key to use to get the value for the field field:DatabaseField DatabaseField the field to find a value for Returns:Object Object

getPkValueFromKeyForField

back to summary

public Object getPkValueFromKeyForField(Object key, DatabaseField field, AbstractSession session)

INTERNAL: Pull the value for the field from the key.

Parameters

key:Object: Object the primary key to use to get the value for the field
field:DatabaseField: DatabaseField the field to find a value for

Returns:Object

Object

initialize	back to summary
public void initialize(ClassDescriptor descriptor, AbstractSession session) throws DescriptorException Overrides org.eclipse.persistence.descriptors.CMPPolicy.initialize. INTERNAL: Initialize the CMPPolicy settings. Annotations @Override

initialize

back to summary

public void initialize(ClassDescriptor descriptor, AbstractSession session) throws DescriptorException

Overrides org.eclipse.persistence.descriptors.CMPPolicy.initialize.

INTERNAL: Initialize the CMPPolicy settings.

Annotations

@Override

initializePrimaryKeyFields	back to summary
protected CMPPolicy.KeyElementAccessor[] initializePrimaryKeyFields(Class<?> keyClass, AbstractSession session) 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.

initializePrimaryKeyFields

back to summary

protected CMPPolicy.KeyElementAccessor[] initializePrimaryKeyFields(Class<?> keyClass, AbstractSession session)

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.

isCMP3Policy	back to summary
public boolean isCMP3Policy() Overrides org.eclipse.persistence.descriptors.CMPPolicy.isCMP3Policy. INTERNAL: Return if this policy is for CMP3. Annotations @Override

isCMP3Policy

back to summary

public boolean isCMP3Policy()

Overrides org.eclipse.persistence.descriptors.CMPPolicy.isCMP3Policy.

INTERNAL: Return if this policy is for CMP3.

Annotations

@Override

remoteInitialize	back to summary
public void remoteInitialize(ClassDescriptor descriptor, AbstractSession session) throws DescriptorException Overrides org.eclipse.persistence.descriptors.CMPPolicy.remoteInitialize. INTERNAL: Initialize the CMPPolicy settings for remote sessions. Annotations @Override

remoteInitialize

back to summary

public void remoteInitialize(ClassDescriptor descriptor, AbstractSession session) throws DescriptorException

Overrides org.eclipse.persistence.descriptors.CMPPolicy.remoteInitialize.

INTERNAL: Initialize the CMPPolicy settings for remote sessions.

Annotations

@Override

setPKClass	back to summary
public void setPKClass(Class<?> pkClass) ADVANCED:

setPrimaryKeyClassName	back to summary
public void setPrimaryKeyClassName(String pkClassName) INTERNAL:

Modifier and Type	Field and Description
private final String	attributeName
private final DatabaseField	databaseField
private final boolean	isNestedAccessor
protected final DatabaseMapping	mapping

Access	Constructor and Description
public	CommonAccessor(String attributeName, DatabaseField field, DatabaseMapping mapping, boolean isNestedAccessor)

Modifier and Type	Method and Description
public String	getAttributeName() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getAttributeName.
public DatabaseField	getDatabaseField() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getDatabaseField.
public DatabaseMapping	getMapping() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getMapping.
public boolean	isNestedAccessor() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.isNestedAccessor.

attributeName	back to summary
private final String attributeName

databaseField	back to summary
private final DatabaseField databaseField

isNestedAccessor	back to summary
private final boolean isNestedAccessor

mapping	back to summary
protected final DatabaseMapping mapping

CommonAccessor	back to summary
public CommonAccessor(String attributeName, DatabaseField field, DatabaseMapping mapping, boolean isNestedAccessor)

getAttributeName	back to summary
public String getAttributeName() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getAttributeName. Annotations @Override

getDatabaseField	back to summary
public DatabaseField getDatabaseField() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getDatabaseField. Annotations @Override

getMapping	back to summary
public DatabaseMapping getMapping() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getMapping. Annotations @Override

isNestedAccessor	back to summary
public boolean isNestedAccessor() Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.isNestedAccessor. Annotations @Override

org.eclipse.persistence.internal.jpa back to summary

private final Class CMP3Policy.FieldAccessor

Class Inheritance

extends CommonAccessor

java.lang.Object
org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor
org.eclipse.persistence.internal.jpa.CMP3Policy.FieldAccessor

INTERNAL: This class will be used when the element of the keyclass is a field

Field Summary

Modifier and Type	Field and Description
private final Field	field
private final CMPPolicy	policy

Inherited from org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor:: mapping

Constructor Summary

Access	Constructor and Description
public	FieldAccessor(CMPPolicy policy, Field field, String attributeName, DatabaseField databaseField, DatabaseMapping mapping, boolean isNestedAccessor)

Method Summary

Modifier and Type	Method and Description
public Object	getValue(Object object, AbstractSession session) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue.
public void	setValue(Object object, Object value) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue.

Inherited from org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor:: getAttributeName getDatabaseField getMapping isNestedAccessor

Field Detail

field	back to summary
private final Field field

policy	back to summary
private final CMPPolicy policy

Constructor Detail

FieldAccessor	back to summary
public FieldAccessor(CMPPolicy policy, Field field, String attributeName, DatabaseField databaseField, DatabaseMapping mapping, boolean isNestedAccessor)

Method Detail

getValue	back to summary
public Object getValue(Object object, AbstractSession session) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue. Annotations @Override

getValue

back to summary

public Object getValue(Object object, AbstractSession session)

Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue.

Annotations

@Override

setValue	back to summary
public void setValue(Object object, Object value) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue. Annotations @Override

setValue

back to summary

public void setValue(Object object, Object value)

Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue.

Annotations

@Override

org.eclipse.persistence.internal.jpa back to summary

private final Class CMP3Policy.PropertyAccessor

Class Inheritance

extends CommonAccessor

java.lang.Object
org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor
org.eclipse.persistence.internal.jpa.CMP3Policy.PropertyAccessor

INTERNAL: This class is used when the key class element is a property

Field Summary

Modifier and Type	Field and Description
private final Method	getMethod
private final CMPPolicy	policy
private final Method	setMethod

Inherited from org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor:: mapping

Constructor Summary

Access	Constructor and Description
public	PropertyAccessor(CMPPolicy policy, Method getMethod, Method setMethod, String attributeName, DatabaseField databaseField, DatabaseMapping mapping, boolean isNestedAccessor)

Method Summary

Modifier and Type	Method and Description
public Object	getValue(Object object, AbstractSession session) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue.
public void	setValue(Object object, Object value) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue.

Inherited from org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor:: getAttributeName getDatabaseField getMapping isNestedAccessor

Field Detail

getMethod	back to summary
private final Method getMethod

policy	back to summary
private final CMPPolicy policy

setMethod	back to summary
private final Method setMethod

Constructor Detail

PropertyAccessor	back to summary
public PropertyAccessor(CMPPolicy policy, Method getMethod, Method setMethod, String attributeName, DatabaseField databaseField, DatabaseMapping mapping, boolean isNestedAccessor)

Method Detail

getValue

back to summary

public Object getValue(Object object, AbstractSession session)

Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue.

Annotations

@Override

setValue

back to summary

public void setValue(Object object, Object value)

Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue.

Annotations

@Override

org.eclipse.persistence.internal.jpa back to summary

private final Class CMP3Policy.ValuesFieldAccessor

Class Inheritance

extends CommonAccessor

java.lang.Object
org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor
org.eclipse.persistence.internal.jpa.CMP3Policy.ValuesFieldAccessor

INTERNAL: This class will be used when the element of the keyclass is a virtual field.

Field Summary

Inherited from org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor:: mapping

Constructor Summary

Access	Constructor and Description
public	ValuesFieldAccessor(String attributeName, DatabaseField databaseField, DatabaseMapping mapping, boolean isNestedAccessor)

Method Summary

Modifier and Type	Method and Description
public Object	getValue(Object object, AbstractSession session) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue.
public void	setValue(Object object, Object value) Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue.

Inherited from org.eclipse.persistence.internal.jpa.CMP3Policy.CommonAccessor:: getAttributeName getDatabaseField getMapping isNestedAccessor

Constructor Detail

ValuesFieldAccessor	back to summary
public ValuesFieldAccessor(String attributeName, DatabaseField databaseField, DatabaseMapping mapping, boolean isNestedAccessor)

Method Detail

getValue

back to summary

public Object getValue(Object object, AbstractSession session)

Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.getValue.

Annotations

@Override

setValue

back to summary

public void setValue(Object object, Object value)

Implements org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor.setValue.

Annotations

@Override

public Class CMP3Policy

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class CMP3Policy.CommonAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CMP3Policy.FieldAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CMP3Policy.PropertyAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CMP3Policy.ValuesFieldAccessor

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail