Module org.eclipse.persistence.core
Package org.eclipse.persistence.mappings.foundation

Interface MapKeyMapping

All Superinterfaces:
MapComponentMapping
All Known Implementing Classes:
AbstractDirectMapping, AggregateObjectMapping, DirectToFieldMapping, DirectToXMLTypeMapping, EISDirectMapping, ManyToOneMapping, OneToOneMapping, XMLBinaryDataMapping, XMLDirectMapping, XMLFragmentMapping
public interface MapKeyMapping extends MapComponentMapping
MapKeyMapping is implemented by DatabaseMappings that can be used to map the key in a map that uses a MappedKeyMapContainerPolicy. This interface provides the facilities to retreive data for the key from the database, to get data from the object to put in the database, and to appropriately initialize the mappings.
See Also:

  • Method Details

    • addAdditionalFieldsToQuery

      void addAdditionalFieldsToQuery(ReadQuery selectionQuery, Expression baseExpression)
      INTERNAL: Used when initializing queries for mappings that use a Map Called when the selection query is being initialized to add the fields for the map key to the query

    • addFieldsForMapKey

      void addFieldsForMapKey(AbstractRecord joinRow)
      INTERNAL: Used when initializing queries for mappings that use a Map Called when the insert query is being initialized to ensure the fields for the map key are in the insert query

    • addKeyToDeletedObjectsList

      void addKeyToDeletedObjectsList(Object object, Map deletedObjects)
      INTERNAL: For mappings used as MapKeys in MappedKeyContainerPolicy. Add the target of this mapping to the deleted objects list if necessary This method is used for removal of private owned relationships

    • buildElementClone

      Object buildElementClone(Object element, Object parent, CacheKey cacheKey, Integer refreshCascade, AbstractSession cloningSession, boolean isExisting, boolean isFromSharedCache)
      Build a clone of the given element in a unitOfWork

    • buildSelectionQueryForDirectCollectionKeyMapping

      ReadQuery buildSelectionQueryForDirectCollectionKeyMapping(ContainerPolicy containerPolicy)
      INTERNAL: Depending on the MapKeyMapping, a different selection query may be required to retrieve the map when the map is based on a DirectCollectionMapping

    • cascadeDiscoverAndPersistUnregisteredNewObjects

      void cascadeDiscoverAndPersistUnregisteredNewObjects(Object object, Map newObjects, Map unregisteredExistingObjects, Map visitedObjects, UnitOfWorkImpl uow, boolean getAttributeValueFromObject, Set cascadeErrors)
      INTERNAL: Cascade discover and persist new objects during commit to the map key

    • cascadePerformRemoveIfRequired

      void cascadePerformRemoveIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects, boolean getAttributeValueFromObject)
      INTERNAL: Cascade perform delete through mappings that require the cascade

    • cascadeRegisterNewIfRequired

      void cascadeRegisterNewIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects, boolean getAttributeValueFromObject)
      INTERNAL: Cascade registerNew for Create through mappings that require the cascade

    • createMapComponentFromJoinedRow

      Object createMapComponentFromJoinedRow(AbstractRecord dbRow, JoinedAttributeManager joinManager, ObjectBuildingQuery query, CacheKey parentCacheKey, AbstractSession session, boolean isTargetProtected)
      INTERNAL Called when a DatabaseMapping is used to map the key in a collection and a join query is used. Returns the key.

    • createQueryKeyForMapKey

      QueryKey createQueryKeyForMapKey()
      INTERNAL: Create a query key that links to the map key

    • createSerializableMapKeyInfo

      Object createSerializableMapKeyInfo(Object key, AbstractSession session)
      INTERNAL: Creates the Array of simple types used to recreate this map.

    • createMapComponentsFromSerializableKeyInfo

      List<Object> createMapComponentsFromSerializableKeyInfo(Object[] keyInfo, AbstractSession session)
      INTERNAL: Create an instance of the Key object from the key information extracted from the map. This may return the value directly in case of a simple key or will be used as the FK to load a related entity.

    • createStubbedMapComponentFromSerializableKeyInfo

      Object createStubbedMapComponentFromSerializableKeyInfo(Object keyInfo, AbstractSession session)
      INTERNAL: Create an instance of the Key object from the key information extracted from the map. This key object may be a shallow stub of the actual object if the key is an Entity type.

    • deleteMapKey

      void deleteMapKey(Object objectDeleted, AbstractSession session)
      INTERNAL: For mappings used as MapKeys in MappedKeyContainerPolicy, Delete the passed object if necessary. This method is used for removal of private owned relationships

    • getAdditionalTablesForJoinQuery

      List<DatabaseTable> getAdditionalTablesForJoinQuery()
      INTERNAL: Return any tables that will be required when this mapping is used as part of a join query

    • getAllFieldsForMapKey

      List<DatabaseField> getAllFieldsForMapKey()
      INTERNAL: Get all the fields for the map key

    • getForeignKeyFieldsForMapKey

      Map<DatabaseField,DatabaseField> getForeignKeyFieldsForMapKey()
      INTERNAL: Return a Map of any foreign keys defined within the the MapKey

    • getReferenceDescriptor

      ClassDescriptor getReferenceDescriptor()
      INTERNAL: Get the descriptor for the Map Key

    • getIdentityFieldsForMapKey

      List<DatabaseField> getIdentityFieldsForMapKey()
      INTERNAL: Return the fields that make up the identity of the mapped object. For mappings with a primary key, it will be the set of fields in the primary key. For mappings without a primary key it will likely be all the fields

    • getNestedJoinQuery

      ObjectLevelReadQuery getNestedJoinQuery(JoinedAttributeManager joinManager, ObjectLevelReadQuery query, AbstractSession session)
      INTERNAL: Return the query that is used when this mapping is part of a joined relationship

    • getAdditionalSelectionCriteriaForMapKey

      Expression getAdditionalSelectionCriteriaForMapKey()
      INTERNAL: Return the selection criteria necessary to select the target object

    • getTargetVersionOfSourceObject

      Object getTargetVersionOfSourceObject(Object object, Object parent, MergeManager mergeManager, AbstractSession targetSession)
      INTERNAL: If required, get the targetVersion of the source object from the merge manager

    • getMapKeyTargetType

      Object getMapKeyTargetType()
      INTERNAL: Return the class this key mapping maps or the descriptor for it

    • iterateOnMapKey

      void iterateOnMapKey(DescriptorIterator iterator, Object element)
      INTERNAL: Called when iterating through descriptors to handle iteration on this mapping when it is used as a MapKey

    • extractIdentityFieldsForQuery

      Map extractIdentityFieldsForQuery(Object key, AbstractSession session)
      INTERNAL: Extract the fields for the Map key from the object to use in a query

    • preinitializeMapKey

      void preinitializeMapKey(DatabaseTable table) throws DescriptorException
      INTERNAL: Making any mapping changes necessary to use a the mapping as a map key prior to initializing the mapping
      Throws:
      DescriptorException

    • postInitializeMapKey

      void postInitializeMapKey(MappedKeyMapContainerPolicy policy) throws DescriptorException
      INTERNAL: Making any mapping changes necessary to use a the mapping as a map key after initializing the mapping
      Throws:
      DescriptorException

    • requiresDataModificationEventsForMapKey

      boolean requiresDataModificationEventsForMapKey()
      INTERNAL: Return whether this mapping requires extra queries to update the rows if it is used as a key in a map. This will typically be true if there are any parts to this mapping that are not read-only.

    • unwrapKey

      Object unwrapKey(Object key, AbstractSession session)
      INTERNAL: Allow the key mapping to unwrap the object

    • wrapKey

      Object wrapKey(Object key, AbstractSession session)
      INTERNAL: Allow the key mapping to wrap the object