org.eclipse.persistence.mappings.EmbeddableMapping Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.persistence.core Show documentation

The newest version!

/*
 * Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     01/28/2009-2.0 Guy Pelletier
//       - 248293: JPA 2.0 Element Collections (part 1)
//     02/06/2009-2.0 Guy Pelletier
//       - 248293: JPA 2.0 Element Collections (part 2)
//     10/25/2012-2.5 Guy Pelletier
//       - 374688: JPA 2.1 Converter support
package org.eclipse.persistence.mappings;

import org.eclipse.persistence.internal.helper.DatabaseField;
import org.eclipse.persistence.mappings.converters.Converter;

/**
 * INTERNAL
 * Common interface to those mappings that are used to map JPA Embedded objects.
 *  - ElementCollection {@literal ->} AggregateCollectionMapping
 *  - Embedded {@literal ->} AggregateObjectMapping
 * 
 * This interface was build to ease the metadata processing, namely to avoid
 * costly casting between the mappings above since their common parent is
 * DatabaseMapping.
 *
 * @author Guy Pelletier
 * @since EclipseLink 1.2
 */
public interface EmbeddableMapping {
    String getAttributeName();
    void addConverter(Converter converter, String attributeName);
    void addOverrideManyToManyMapping(ManyToManyMapping mapping);
    void addOverrideUnidirectionalOneToManyMapping(UnidirectionalOneToManyMapping mapping);
    void addFieldTranslation(DatabaseField sourceFieldName, String aggregateFieldName);
    void addNestedFieldTranslation(String attributeName, DatabaseField sourceField, String aggregateField);
}