EclipseLink JPA 4.0.2 · org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.RelationshipAccessor

Modifier and Type	Field and Description
private BatchFetchMetadata	m_batchFetch
private CascadeMetadata	m_cascade
private Boolean	m_cascadeOnDelete
private String	m_fetch
private ForeignKeyMetadata	m_foreignKey
private List<JoinColumnMetadata>	m_joinColumns
private String	m_joinFetch
private List<JoinFieldMetadata>	m_joinFields
private JoinTableMetadata	m_joinTable
private String	m_mappedBy
private Boolean	m_nonCacheable
private Boolean	m_orphanRemoval
private Boolean	m_privateOwned
protected MetadataClass	m_referenceClass
private MetadataClass	m_targetEntity
private String	m_targetEntityName

Constructor Summary

Access	Constructor and Description
protected	RelationshipAccessor(String xmlElement) INTERNAL:
protected	RelationshipAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor) INTERNAL:

Method Summary

Modifier and Type	Method and Description
protected void	addJoinTableRelationKeyFields(List<JoinColumnMetadata> joinColumns, RelationTableMechanism mechanism, String defaultFieldName, MetadataDescriptor descriptor, boolean isSource) INTERNAL: Add the relation key fields to a many to many mapping.
public boolean	equals(Object the reference object with which to compare. objectToCompare) Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.equals. INTERNAL:
public BatchFetchMetadata	getBatchFetch() INTERNAL: Used for OX mapping.
public CascadeMetadata	getCascade() INTERNAL: Used for OX mapping.
public Boolean	getCascadeOnDelete() INTERNAL: Used for OX mapping.
public abstract String	getDefaultFetchType() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultFetchType. INTERNAL:
protected DatabaseTable	getDefaultTableForEntityMapKey() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultTableForEntityMapKey. INTERNAL: Return the default table to hold the foreign key of a MapKey when and Entity is used as the MapKey
public String	getFetch() INTERNAL: Used for OX mapping.
public ForeignKeyMetadata	getForeignKey() INTERNAL: Used for OX mapping.
public List<JoinColumnMetadata>	getJoinColumns() INTERNAL: Used for OX mapping.
public String	getJoinFetch() INTERNAL: Used for OX mapping.
public List<JoinFieldMetadata>	getJoinFields() INTERNAL: Used for OX mapping.
public JoinTableMetadata	getJoinTable() INTERNAL: Used for OX mapping.
protected JoinTableMetadata	getJoinTableMetadata() INTERNAL: This method will return the join table metadata to be processed with this relationship accessor.
protected abstract String	getLoggingContext() INTERNAL: Return the logging context for this accessor.
public String	getMappedBy() INTERNAL: Used for OX mapping.
public Boolean	getNonCacheable() INTERNAL: Used for OX mapping.
public Boolean	getOrphanRemoval() INTERNAL: Used for OX mapping.
protected DatabaseMapping	getOwningMapping() INTERNAL: Method to return an owner mapping.
public Boolean	getPrivateOwned() INTERNAL: Used for OX mapping.
public MetadataDescriptor	getReferenceDescriptor() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getReferenceDescriptor. INTERNAL: Return the reference metadata descriptor for this accessor.
public MetadataClass	getTargetEntity() INTERNAL: Return the target entity for this accessor.
public String	getTargetEntityName() INTERNAL: Used for OX mapping.
public int	hashCode() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hashCode. Returns a hash code value for the object.
protected boolean	hasJoinTable() INTERNAL: Return true if a join table exists for this accessor (either directly set or through an association override).
public boolean	hasMappedBy() INTERNAL: Return true if this accessor is the non owning side of the relationship, that is, has a mapped by value.
public void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.initXMLObject. INTERNAL:
public boolean	isCascadeOnDelete() INTERNAL:
public boolean	isLazy() INTERNAL: Return if the accessor should be lazy fetched.
public boolean	isNonCacheable() INTERNAL: Used for OX mapping.
protected boolean	isOrphanRemoval() INTERNAL: Return true is this relationship employs orphanRemoval.
public boolean	isPrivateOwned() INTERNAL: Used for OX mapping.
public boolean	isValueHolderInterface() INTERNAL: If somehow we are processing a class that was weaved to have value holders, we should ignore the processing of this mapping.
public void	process() Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor.process. INTERNAL: Common validation done by all relationship accessors.
protected void	processBatchFetch(ForeignReferenceMapping mapping) INTERNAL: Set the batch fetch type on the foreign reference mapping.
protected void	processCascadeTypes(ForeignReferenceMapping mapping) INTERNAL:
protected void	processJoinTable(ForeignReferenceMapping mapping, RelationTableMechanism mechanism, JoinTableMetadata joinTable) INTERNAL: Process a MetadataJoinTable.
protected void	processMappedByRelationTable(RelationTableMechanism ownerMechanism, RelationTableMechanism mechanism) INTERNAL:
protected void	processOrphanRemoval(ForeignReferenceMapping mapping) INTERNAL: This method should be called for all mappings even though they may not support.
protected void	processRelationshipMapping(ForeignReferenceMapping mapping) INTERNAL: Process settings common to ForeignReferenceMapping.
protected void	setAccessorMethods(DatabaseMapping mapping) Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.setAccessorMethods. INTERNAL: Set the getter and setter access methods for this accessor.
public void	setBatchFetch(BatchFetchMetadata batchFetch) INTERNAL: Used for OX mapping.
public void	setCascade(CascadeMetadata cascade) INTERNAL: Used for OX mapping.
public void	setCascadeOnDelete(Boolean cascadeOnDelete) INTERNAL: Used for OX mapping.
public void	setFetch(String fetch) INTERNAL: Used for OX mapping.
public void	setForeignKey(ForeignKeyMetadata foreignKey) INTERNAL: Used for OX mapping.
public void	setJoinColumns(List<JoinColumnMetadata> joinColumns) INTERNAL: Used for OX mapping.
public void	setJoinFetch(String joinFetch) INTERNAL: Used for OX mapping.
public void	setJoinFields(List<JoinFieldMetadata> joinFields) INTERNAL: Used for OX mapping.
public void	setJoinTable(JoinTableMetadata joinTable) INTERNAL: Used for OX mapping.
public void	setMappedBy(String mappedBy) INTERNAL: Used for OX mapping.
public void	setNonCacheable(Boolean noncacheable) INTERNAL: Used for OX mapping.
public void	setOrphanRemoval(Boolean orphanRemoval) INTERNAL: Used for OX mapping.
public void	setPrivateOwned(Boolean privateOwned) INTERNAL: Used for OX mapping.
public void	setTargetEntity(MetadataClass targetEntity) INTERNAL:
public void	setTargetEntityName(String targetEntityName) INTERNAL: Used for OX mapping.
protected boolean	usesIndirection() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.usesIndirection. INTERNAL:

Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor:: addConvert addConvertMetadata addFieldNameTranslation addMapKeyConvert derivesId getAnnotation getAssociationOverrides getAttributeName getAttributeOverride getAttributeOverrides getAttributeType getClassAccessor getColumn getConverts getDatabaseField getEnumerated getField getForeignKey getGetMethodName getJoinColumns getJoinColumnsAndValidate getLob getMapKey getMapKeyConverts getMapKeyReferenceClass getMapKeyReferenceClassName getMapKeyReferenceClassWithGenerics getMapping getOwningDescriptor getOwningDescriptors getRawClass getRawClassWithGenerics getReferenceAccessors getReferenceClass getReferenceClassFromGeneric getReferenceClassName getReferenceClassWithGenerics getReferenceDatabaseTable getSetMethodName getTemporal hasAttributeOverride hasAttributeType hasEnumerated hasLob hasMapKey hasReturnInsert hasReturnUpdate hasTemporal initXMLMappingAccessor isAnnotationPresent isBasic isBasicCollection isBasicMap isCollectionAccessor isDerivedIdClass isDirectCollection isDirectEmbeddableCollection isEmbedded isEmbeddedId isEnumerated isId isJson isLob isManyToMany isManyToOne isMapAccessor isMappedKeyMapAccessor isMultitenantId isOneToMany isOneToOne isPrimitiveWrapperClass isProcessed isRelationship isSerialized isTemporal isTimeClass isTransient isUUID isValidJsonType isValidSerializedType isVariableOneToOne processAssociationOverride processAssociationOverrides processAttributeOverrides processContainerPolicyAndIndirection processConvert processConverts processDirectMapKeyClass processEmbeddableMapKeyClass processEntityMapKeyClass processEnumerated processForeignKeyRelationship processIndirection processJoinFetch processJson processLob processMapKeyClass processMappingConverter processMappingKeyConverter processMappingValueConverter processProperties processProperty processReturnInsert processReturnInsertAndUpdate processReturnUpdate processSerialized processSerialized processTemporal processUUID setAttributeType setClassAccessor setField setIndirectionPolicy setMapping setOverrideMapping setTemporal toString updatePrimaryKeyField usesFieldAccess usesPropertyAccess usesVirtualAccess

Field Detail

m_batchFetch	back to summary
private BatchFetchMetadata m_batchFetch

m_cascade	back to summary
private CascadeMetadata m_cascade

m_cascadeOnDelete	back to summary
private Boolean m_cascadeOnDelete

m_fetch	back to summary
private String m_fetch

m_foreignKey	back to summary
private ForeignKeyMetadata m_foreignKey

m_joinColumns	back to summary
private List<JoinColumnMetadata> m_joinColumns

m_joinFetch	back to summary
private String m_joinFetch

m_joinFields	back to summary
private List<JoinFieldMetadata> m_joinFields

m_joinTable	back to summary
private JoinTableMetadata m_joinTable

m_mappedBy	back to summary
private String m_mappedBy

m_nonCacheable	back to summary
private Boolean m_nonCacheable

m_orphanRemoval	back to summary
private Boolean m_orphanRemoval

m_privateOwned	back to summary
private Boolean m_privateOwned

m_referenceClass	back to summary
protected MetadataClass m_referenceClass

m_targetEntity	back to summary
private MetadataClass m_targetEntity

m_targetEntityName	back to summary
private String m_targetEntityName

Constructor Detail

RelationshipAccessor	back to summary
protected RelationshipAccessor(String xmlElement) INTERNAL:

RelationshipAccessor	back to summary
protected RelationshipAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor) INTERNAL:

Method Detail

addJoinTableRelationKeyFields	back to summary
protected void addJoinTableRelationKeyFields(List<JoinColumnMetadata> joinColumns, RelationTableMechanism mechanism, String defaultFieldName, MetadataDescriptor descriptor, boolean isSource) INTERNAL: Add the relation key fields to a many to many mapping.

equals back to summary

equals	back to summary
public boolean equals(Object objectToCompare) Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.equals. INTERNAL: Parameters objectToCompare:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.equals.

INTERNAL:

Parameters

objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getBatchFetch	back to summary
public BatchFetchMetadata getBatchFetch() INTERNAL: Used for OX mapping.

getCascade	back to summary
public CascadeMetadata getCascade() INTERNAL: Used for OX mapping.

getCascadeOnDelete	back to summary
public Boolean getCascadeOnDelete() INTERNAL: Used for OX mapping.

getDefaultFetchType	back to summary
public abstract String getDefaultFetchType() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultFetchType. INTERNAL: Annotations @Override

getDefaultFetchType

back to summary

public abstract String getDefaultFetchType()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultFetchType.

INTERNAL:

Annotations

@Override

getDefaultTableForEntityMapKey	back to summary
protected DatabaseTable getDefaultTableForEntityMapKey() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultTableForEntityMapKey. INTERNAL: Return the default table to hold the foreign key of a MapKey when and Entity is used as the MapKey Annotations @Override

getDefaultTableForEntityMapKey

back to summary

protected DatabaseTable getDefaultTableForEntityMapKey()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultTableForEntityMapKey.

INTERNAL: Return the default table to hold the foreign key of a MapKey when and Entity is used as the MapKey

Annotations

@Override

getFetch	back to summary
public String getFetch() INTERNAL: Used for OX mapping.

getForeignKey	back to summary
public ForeignKeyMetadata getForeignKey() INTERNAL: Used for OX mapping.

getJoinColumns	back to summary
public List<JoinColumnMetadata> getJoinColumns() INTERNAL: Used for OX mapping.

getJoinFetch	back to summary
public String getJoinFetch() INTERNAL: Used for OX mapping.

getJoinFields	back to summary
public List<JoinFieldMetadata> getJoinFields() INTERNAL: Used for OX mapping.

getJoinTable	back to summary
public JoinTableMetadata getJoinTable() INTERNAL: Used for OX mapping.

getJoinTableMetadata	back to summary
protected JoinTableMetadata getJoinTableMetadata() INTERNAL: This method will return the join table metadata to be processed with this relationship accessor. It will first check for a join table from an association override, followed by a join table defined directly on the accessor. If neither is present, a join table metadata is defaulted.

getLoggingContext	back to summary
protected abstract String getLoggingContext() INTERNAL: Return the logging context for this accessor.

getMappedBy	back to summary
public String getMappedBy() INTERNAL: Used for OX mapping.

getNonCacheable	back to summary
public Boolean getNonCacheable() INTERNAL: Used for OX mapping.

getOrphanRemoval	back to summary
public Boolean getOrphanRemoval() INTERNAL: Used for OX mapping.

getOwningMapping	back to summary
protected DatabaseMapping getOwningMapping() INTERNAL: Method to return an owner mapping. It will tell the owner class to process itself if it hasn't already done so. Assumes that a mapped by value has been specified and that a check against mappedBy has been done.

getPrivateOwned	back to summary
public Boolean getPrivateOwned() INTERNAL: Used for OX mapping.

getReferenceDescriptor	back to summary
public MetadataDescriptor getReferenceDescriptor() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getReferenceDescriptor. INTERNAL: Return the reference metadata descriptor for this accessor. This method does additional checks to make sure that the target entity is indeed an entity class. Annotations @Override

getReferenceDescriptor

back to summary

public MetadataDescriptor getReferenceDescriptor()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getReferenceDescriptor.

INTERNAL: Return the reference metadata descriptor for this accessor. This method does additional checks to make sure that the target entity is indeed an entity class.

Annotations

@Override

getTargetEntity	back to summary
public MetadataClass getTargetEntity() INTERNAL: Return the target entity for this accessor.

getTargetEntityName	back to summary
public String getTargetEntityName() INTERNAL: Used for OX mapping.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasJoinTable	back to summary
protected boolean hasJoinTable() INTERNAL: Return true if a join table exists for this accessor (either directly set or through an association override).

hasMappedBy	back to summary
public boolean hasMappedBy() INTERNAL: Return true if this accessor is the non owning side of the relationship, that is, has a mapped by value.

initXMLObject

back to summary

public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.initXMLObject.

INTERNAL:

Annotations

@Override

isCascadeOnDelete	back to summary
public boolean isCascadeOnDelete() INTERNAL:

isLazy	back to summary
public boolean isLazy() INTERNAL: Return if the accessor should be lazy fetched.

isNonCacheable	back to summary
public boolean isNonCacheable() INTERNAL: Used for OX mapping.

isOrphanRemoval	back to summary
protected boolean isOrphanRemoval() INTERNAL: Return true is this relationship employs orphanRemoval.

isPrivateOwned	back to summary
public boolean isPrivateOwned() INTERNAL: Used for OX mapping.

isValueHolderInterface	back to summary
public boolean isValueHolderInterface() INTERNAL: If somehow we are processing a class that was weaved to have value holders, we should ignore the processing of this mapping.

process

back to summary

public void process()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor.process.

INTERNAL: Common validation done by all relationship accessors.

Annotations

@Override

processBatchFetch	back to summary
protected void processBatchFetch(ForeignReferenceMapping mapping) INTERNAL: Set the batch fetch type on the foreign reference mapping.

processCascadeTypes	back to summary
protected void processCascadeTypes(ForeignReferenceMapping mapping) INTERNAL:

processJoinTable	back to summary
protected void processJoinTable(ForeignReferenceMapping mapping, RelationTableMechanism mechanism, JoinTableMetadata joinTable) INTERNAL: Process a MetadataJoinTable.

processMappedByRelationTable	back to summary
protected void processMappedByRelationTable(RelationTableMechanism ownerMechanism, RelationTableMechanism mechanism) INTERNAL:

processOrphanRemoval

back to summary

protected void processOrphanRemoval(ForeignReferenceMapping mapping)

INTERNAL: This method should be called for all mappings even though they may not support. The reason is that we want to log a message for those mappings that try to employ a private owned setting when it is not supported on their mapping. Order of checking is as follows: 1 - check for orphanRemoval first. Through meta data, this can only be true for 1-1, 1-M and V1-1 2 - check for isPrivateOwned. Do no check the variable directly as the isPrivateOwned method is overridden in those classes that do not support it (to check if the user decorated the mapping with a private owned and log a warning message that we are ignoring it.)

processRelationshipMapping	back to summary
protected void processRelationshipMapping(ForeignReferenceMapping mapping) INTERNAL: Process settings common to ForeignReferenceMapping.

setAccessorMethods

back to summary

protected void setAccessorMethods(DatabaseMapping mapping)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.setAccessorMethods.

INTERNAL: Set the getter and setter access methods for this accessor.

Annotations

@Override

setBatchFetch	back to summary
public void setBatchFetch(BatchFetchMetadata batchFetch) INTERNAL: Used for OX mapping.

setCascade	back to summary
public void setCascade(CascadeMetadata cascade) INTERNAL: Used for OX mapping.

setCascadeOnDelete	back to summary
public void setCascadeOnDelete(Boolean cascadeOnDelete) INTERNAL: Used for OX mapping.

setFetch	back to summary
public void setFetch(String fetch) INTERNAL: Used for OX mapping.

setForeignKey	back to summary
public void setForeignKey(ForeignKeyMetadata foreignKey) INTERNAL: Used for OX mapping.

setJoinColumns	back to summary
public void setJoinColumns(List<JoinColumnMetadata> joinColumns) INTERNAL: Used for OX mapping.

setJoinFetch	back to summary
public void setJoinFetch(String joinFetch) INTERNAL: Used for OX mapping.

setJoinFields	back to summary
public void setJoinFields(List<JoinFieldMetadata> joinFields) INTERNAL: Used for OX mapping.

setJoinTable	back to summary
public void setJoinTable(JoinTableMetadata joinTable) INTERNAL: Used for OX mapping.

setMappedBy	back to summary
public void setMappedBy(String mappedBy) INTERNAL: Used for OX mapping.

setNonCacheable	back to summary
public void setNonCacheable(Boolean noncacheable) INTERNAL: Used for OX mapping.

setOrphanRemoval	back to summary
public void setOrphanRemoval(Boolean orphanRemoval) INTERNAL: Used for OX mapping.

setPrivateOwned	back to summary
public void setPrivateOwned(Boolean privateOwned) INTERNAL: Used for OX mapping.

setTargetEntity	back to summary
public void setTargetEntity(MetadataClass targetEntity) INTERNAL:

setTargetEntityName	back to summary
public void setTargetEntityName(String targetEntityName) INTERNAL: Used for OX mapping.

usesIndirection

back to summary

protected boolean usesIndirection()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.usesIndirection.

INTERNAL:

Annotations

@Override

public abstract Class RelationshipAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail