Uses of Class
org.eclipse.persistence.mappings.ForeignReferenceMapping

Packages that use ForeignReferenceMapping

Package	Description
org.eclipse.persistence.descriptors.changetracking
org.eclipse.persistence.eis.mappings
org.eclipse.persistence.exceptions
org.eclipse.persistence.internal.identitymaps
org.eclipse.persistence.internal.indirection
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings
org.eclipse.persistence.internal.jpa.metadata.mappings
org.eclipse.persistence.internal.queries
org.eclipse.persistence.internal.sessions
org.eclipse.persistence.mappings
org.eclipse.persistence.mappings.structures
org.eclipse.persistence.sessions.factories
org.eclipse.persistence.sessions.interceptors
org.eclipse.persistence.tools.schemaframework

Uses of ForeignReferenceMapping in org.eclipse.persistence.descriptors.changetracking

Methods in org.eclipse.persistence.descriptors.changetracking with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
void	AttributeChangeTrackingPolicy.updateListenerForSelfMerge(ObjectChangeListener listener, ForeignReferenceMapping mapping, Object source, Object target, UnitOfWorkImpl unitOfWork)	INTERNAL: In cases where a relationship with detached or new entities is merged into itself previous changes may have been recorded for the detached/new entity that need to be updated.
void	DeferredChangeDetectionPolicy.updateListenerForSelfMerge(ObjectChangeListener listener, ForeignReferenceMapping mapping, Object source, Object target, UnitOfWorkImpl unitOfWork)	INTERNAL: In cases where a relationship with detached or new entities is merged into itself previous changes may have been recorded for the detached/new entity that need to be updated.
void	ObjectChangePolicy.updateListenerForSelfMerge(ObjectChangeListener listener, ForeignReferenceMapping mapping, Object source, Object target, UnitOfWorkImpl unitOfWork)	INTERNAL: In cases where a relationship with detached or new entities is merged into itself previous changes may have been recorded for the detached/new entity that need to be updated.

Uses of ForeignReferenceMapping in org.eclipse.persistence.eis.mappings

Subclasses of ForeignReferenceMapping in org.eclipse.persistence.eis.mappings

Modifier and Type	Class	Description
class	EISOneToManyMapping	An EIS one-to-many mapping is a reference mapping that represents the relationship between a single source object and a collection of mapped persistent Java objects.
class	EISOneToOneMapping	An EIS one-to-one mapping is a reference mapping that represents the relationship between a single source object and a single mapped persistent Java object.

Uses of ForeignReferenceMapping in org.eclipse.persistence.exceptions

Methods in org.eclipse.persistence.exceptions with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
static DescriptorException	DescriptorException.foreignKeysDefinedIncorrectly(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.invalidDataModificationEventCode(Object event, ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.missingForeignKeyTranslation(ForeignReferenceMapping mapping, DatabaseField primaryKeyField)
static DescriptorException	DescriptorException.noForeignKeysAreSpecified(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.noReferenceKeyIsSpecified(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.noSourceRelationKeysSpecified(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.noTargetForeignKeysSpecified(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.noTargetRelationKeysSpecified(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.referenceKeyFieldNotProperlySpecified(DatabaseField field, ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.relationKeyFieldNotProperlySpecified(DatabaseField field, ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.sizeMismatchOfForeignKeys(ForeignReferenceMapping mapping)
static DescriptorException	DescriptorException.targetForeignKeysSizeMismatch(ForeignReferenceMapping mapping)

Uses of ForeignReferenceMapping in org.eclipse.persistence.internal.identitymaps

Methods in org.eclipse.persistence.internal.identitymaps with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
void	FullIdentityMap.lazyRelationshipLoaded(Object object, ValueHolderInterface valueHolder, ForeignReferenceMapping mapping)	Notify the cache that a lazy relationship has been triggered in the object and the cache may need to be updated
void	IdentityMap.lazyRelationshipLoaded(Object rootEntity, ValueHolderInterface valueHolder, ForeignReferenceMapping mapping)	Notify the cache that a lazy relationship has been triggered in the object and the cache may need to be updated
void	NoIdentityMap.lazyRelationshipLoaded(Object object, ValueHolderInterface valueHolder, ForeignReferenceMapping mapping)	Notify the cache that a lazy relationship has been triggered in the object and the cache may need to be updated

Uses of ForeignReferenceMapping in org.eclipse.persistence.internal.indirection

Fields in org.eclipse.persistence.internal.indirection declared as ForeignReferenceMapping

Modifier and Type	Field	Description
protected ForeignReferenceMapping	BatchValueHolder.mapping
protected ForeignReferenceMapping	CacheBasedValueHolder.mapping

Methods in org.eclipse.persistence.internal.indirection that return ForeignReferenceMapping

Modifier and Type	Method	Description
protected ForeignReferenceMapping	IndirectionPolicy.getForeignReferenceMapping()	INTERNAL: Reduce casting clutter....
protected ForeignReferenceMapping	BatchValueHolder.getMapping()

Methods in org.eclipse.persistence.internal.indirection with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
protected void	BatchValueHolder.setMapping(ForeignReferenceMapping mapping)

Constructors in org.eclipse.persistence.internal.indirection with parameters of type ForeignReferenceMapping

Modifier	Constructor	Description
	BatchValueHolder(ReadQuery query, AbstractRecord row, ForeignReferenceMapping mapping, ObjectLevelReadQuery originalQuery, CacheKey parentCacheKey)	Initialize the query-based value holder.
	CacheBasedValueHolder(Object[] pks, AbstractRecord foreignKeys, AbstractSession session, ForeignReferenceMapping mapping)
	UnitOfWorkQueryValueHolder(ValueHolderInterface<T> attributeValue, Object clone, ForeignReferenceMapping mapping, AbstractRecord row, UnitOfWorkImpl unitOfWork)

Uses of ForeignReferenceMapping in org.eclipse.persistence.internal.jpa.metadata.accessors.mappings

Methods in org.eclipse.persistence.internal.jpa.metadata.accessors.mappings with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
protected void	DirectCollectionAccessor.processBatchFetch(ForeignReferenceMapping mapping)	INTERNAL: Set the batch fetch type on the foreign reference mapping.
protected void	RelationshipAccessor.processBatchFetch(ForeignReferenceMapping mapping)	INTERNAL: Set the batch fetch type on the foreign reference mapping.
protected void	RelationshipAccessor.processCascadeTypes(ForeignReferenceMapping mapping)	INTERNAL:
protected void	MappingAccessor.processForeignKeyRelationship(ForeignReferenceMapping mapping, List<JoinColumnMetadata> joinColumns, ForeignKeyMetadata foreignKey, MetadataDescriptor referenceDescriptor, String defaultFKFieldName, DatabaseTable defaultFKTable)	INTERNAL: Process the join columns for the owning side of a one to one mapping.
protected void	MappingAccessor.processIndirection(ForeignReferenceMapping mapping)	INTERNAL: Process the indirection (aka fetch type)
protected void	MappingAccessor.processJoinFetch(String joinFetch, ForeignReferenceMapping mapping)	INTERNAL: Return the mapping join fetch type.
protected void	RelationshipAccessor.processJoinTable(ForeignReferenceMapping mapping, RelationTableMechanism mechanism, JoinTableMetadata joinTable)	INTERNAL: Process a MetadataJoinTable.
protected void	RelationshipAccessor.processOrphanRemoval(ForeignReferenceMapping mapping)	INTERNAL: This method should be called for all mappings even though they may not support.
protected void	RelationshipAccessor.processRelationshipMapping(ForeignReferenceMapping mapping)	INTERNAL: Process settings common to ForeignReferenceMapping.

Uses of ForeignReferenceMapping in org.eclipse.persistence.internal.jpa.metadata.mappings

Methods in org.eclipse.persistence.internal.jpa.metadata.mappings with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
void	BatchFetchMetadata.process(ForeignReferenceMapping mapping)	INTERNAL: Process the batch fetch metadata for the given mapping.
void	CascadeMetadata.process(ForeignReferenceMapping mapping)	INTERNAL: Process the cascade types for the given mapping.

Uses of ForeignReferenceMapping in org.eclipse.persistence.internal.queries

Methods in org.eclipse.persistence.internal.queries with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
Expression	JoinedAttributeManager.addAndPrepareJoinedMapping(ForeignReferenceMapping mapping, AbstractSession session)	Add the mapping for join fetch, prepare and return the join expression being used.
protected boolean	ExpressionQueryMechanism.shouldBuildDeleteStatementForMapping(ForeignReferenceMapping frMapping, boolean dontCheckDescriptor, ClassDescriptor descriptor)
void	ContainerPolicy.updateChangeRecordForSelfMerge(ChangeRecord changeRecord, Object source, Object target, ForeignReferenceMapping mapping, UnitOfWorkChangeSet parentUOWChangeSet, UnitOfWorkImpl unitOfWork)	INTERNAL: Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity.
void	ListContainerPolicy.updateChangeRecordForSelfMerge(ChangeRecord changeRecord, Object source, Object target, ForeignReferenceMapping mapping, UnitOfWorkChangeSet parentUOWChangeSet, UnitOfWorkImpl unitOfWork)	INTERNAL: Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity.
void	OrderedListContainerPolicy.updateChangeRecordForSelfMerge(ChangeRecord changeRecord, Object source, Object target, ForeignReferenceMapping mapping, UnitOfWorkChangeSet parentUOWChangeSet, UnitOfWorkImpl unitOfWork)	INTERNAL: Update a ChangeRecord to replace the ChangeSet for the old entity with the changeSet for the new Entity.
Object	ContainerPolicy.valueFromPKList(Object[] pks, AbstractRecord foreignKeys, ForeignReferenceMapping mapping, AbstractSession session)	INTERNAL: This method is used to load a relationship from a list of PKs.
Object	ListContainerPolicy.valueFromPKList(Object[] pks, AbstractRecord foreignKeys, ForeignReferenceMapping mapping, AbstractSession session)	INTERNAL: This method is used to load a relationship from a list of PKs.
Object	MapContainerPolicy.valueFromPKList(Object[] pks, AbstractRecord foreignKeys, ForeignReferenceMapping mapping, AbstractSession session)	INTERNAL: This method is used to load a relationship from a list of PKs.
Object	MappedKeyMapContainerPolicy.valueFromPKList(Object[] pks, AbstractRecord foreignKeys, ForeignReferenceMapping mapping, AbstractSession session)	INTERNAL: This method is used to load a relationship from a list of PKs.

Uses of ForeignReferenceMapping in org.eclipse.persistence.internal.sessions

Methods in org.eclipse.persistence.internal.sessions with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
<T> DatabaseValueHolder<T>	AbstractSession.createCloneQueryValueHolder(ValueHolderInterface<T> attributeValue, Object clone, AbstractRecord row, ForeignReferenceMapping mapping)
<T> DatabaseValueHolder<T>	UnitOfWorkImpl.createCloneQueryValueHolder(ValueHolderInterface<T> attributeValue, Object clone, AbstractRecord row, ForeignReferenceMapping mapping)

Uses of ForeignReferenceMapping in org.eclipse.persistence.mappings

Subclasses of ForeignReferenceMapping in org.eclipse.persistence.mappings

Modifier and Type	Class	Description
class	AggregateCollectionMapping	Purpose: The aggregate collection mapping is used to represent the aggregate relationship between a single source object and a collection of target objects.
class	CollectionMapping	Purpose: Abstract class for relationship mappings which store collection of objects
class	DirectCollectionMapping	Purpose: This mapping is used to store a collection of simple types (String, Number, Date, etc.) into a single table.
class	DirectMapMapping	Mapping for a collection of key-value pairs.
class	ManyToManyMapping	Purpose: Many to many mappings are used to represent the relationships between a collection of source objects and a collection of target objects.
class	ManyToOneMapping	Purpose: Define the relationship to be a ManyToOne.
class	ObjectReferenceMapping	Purpose: Abstract class for 1:1, variable 1:1 and reference mappings
class	OneToManyMapping	Purpose: This mapping is used to represent the typical RDBMS relationship between a single source object and collection of target objects; where, on the database, the target objects have references (foreign keys) to the source object.
class	OneToOneMapping	Purpose: One to one mappings are used to represent a pointer references between two java objects.
class	UnidirectionalOneToManyMapping	Purpose: UnidirectionalOneToManyMapping doesn't have 1:1 back reference mapping.
class	VariableOneToOneMapping	Purpose: Variable one to one mappings are used to represent a pointer references between a java object and an implementer of an interface.

Methods in org.eclipse.persistence.mappings with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
AbstractRecord	RelationTableMechanism.addRelationTableSourceRow(Object sourceObject, AbstractSession session, AbstractRecord databaseRow, ForeignReferenceMapping mapping)	INTERNAL: Add to a row source relation fields with values extracted from the source object.
AbstractRecord	RelationTableMechanism.addRelationTableTargetRow(Object targetObject, AbstractSession session, AbstractRecord databaseRow, ForeignReferenceMapping mapping)	INTERNAL: Add to a row target relation fields with values extracted from the target object.
AbstractRecord	RelationTableMechanism.buildRelationTableSourceAndTargetRow(Object sourceObject, Object targetObject, AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Create a row that contains source relation fields with values extracted from the source object and target relation fields with values extracted from the target object.
AbstractRecord	RelationTableMechanism.buildRelationTableSourceAndTargetRow(AbstractRecord sourceRow, Object targetObject, AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Create a row that contains source relation fields with values extracted from the source row and target relation fields with values extracted from the target object.
AbstractRecord	RelationTableMechanism.buildRelationTableSourceRow(Object sourceObject, AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Create a row that contains source relation fields with values extracted from the source object.
Expression	RelationTableMechanism.buildSelectionCriteriaAndAddFieldsToQueryInternal(ForeignReferenceMapping mapping, Expression criteria, boolean shouldAddTargetFields, boolean shouldAddFieldsToQuery)	INTERNAL: Build the selection criteria to join the source, relation, and target tables.
void	RelationTableMechanism.initialize(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Initialize
protected void	RelationTableMechanism.initializeDeleteQuery(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Initialize delete query.
protected void	RelationTableMechanism.initializeExtendPessimisticLockScope(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Initialize extendPessimisticLockeScope and lockRelationTableQuery (if required).
protected void	RelationTableMechanism.initializeInsertQuery(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Initialize insert query.
protected void	RelationTableMechanism.initializeLockRelationTableQuery(AbstractSession session, ForeignReferenceMapping mapping, Expression startCriteria)	INTERNAL: Initialize lockRelationTableQuery.
protected void	RelationTableMechanism.initializeRelationTable(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: Set the table qualifier on the relation table if required
protected void	RelationTableMechanism.initializeSourceKeys(ForeignReferenceMapping mapping)	INTERNAL: All the source key field names are converted to DatabaseField and stored.
protected void	RelationTableMechanism.initializeSourceRelationKeys(ForeignReferenceMapping mapping)	INTERNAL: All the source relation key field names are converted to DatabaseField and stored.
protected void	RelationTableMechanism.initializeTargetKeys(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: All the target key field names are converted to DatabaseField and stored.
protected void	RelationTableMechanism.initializeTargetKeysWithDefaults(AbstractSession session, ForeignReferenceMapping mapping)	INTERNAL: If a user does not specify the target key then the primary keys of the target table are used.
protected void	RelationTableMechanism.initializeTargetRelationKeys(ForeignReferenceMapping mapping)	INTERNAL: All the target relation key field names are converted to DatabaseField and stored.

Uses of ForeignReferenceMapping in org.eclipse.persistence.mappings.structures

Subclasses of ForeignReferenceMapping in org.eclipse.persistence.mappings.structures

Modifier and Type	Class	Description
class	NestedTableMapping	Purpose: Nested tables are similar to VARRAYs except internally they store their information in a separate table from their parent structure's table.
class	ReferenceMapping	Purpose: In an object-relational data model, structures reference each other through "Refs"; not through foreign keys as in the relational data model.

Uses of ForeignReferenceMapping in org.eclipse.persistence.sessions.factories

Methods in org.eclipse.persistence.sessions.factories with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
protected void	ProjectClassGenerator.addForeignReferenceMappingLines(NonreflectiveMethodDefinition method, String mappingName, ForeignReferenceMapping mapping)

Uses of ForeignReferenceMapping in org.eclipse.persistence.sessions.interceptors

Methods in org.eclipse.persistence.sessions.interceptors with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
void	CacheInterceptor.lazyRelationshipLoaded(Object rootEntity, ValueHolderInterface valueHolder, ForeignReferenceMapping mapping)	Notify the cache that a lazy relationship has been triggered in the object and the cache may need to be updated

Uses of ForeignReferenceMapping in org.eclipse.persistence.tools.schemaframework

Methods in org.eclipse.persistence.tools.schemaframework with parameters of type ForeignReferenceMapping

Modifier and Type	Method	Description
protected void	DefaultTableGenerator.buildRelationTableDefinition(ForeignReferenceMapping mapping, RelationTableMechanism relationTableMechanism, DatabaseField listOrderField, ContainerPolicy cp)	Build relation table definitions for all many-to-many relationships in a EclipseLink descriptor.
protected void	DefaultTableGenerator.buildRelationTableFields(ForeignReferenceMapping mapping, TableDefinition table, List<DatabaseField> fkFields, List<DatabaseField> targetFields)	Build field definitions and foreign key constraints for all many-to-many relation table.