org.eclipse.persistence.eis.mappings.EISTransformationMapping Maven / Gradle / Ivy

Go to download

/*
 * Copyright (c) 1998, 2018 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:
//     Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.eis.mappings;

import org.eclipse.persistence.mappings.foundation.AbstractTransformationMapping;

/**
 * EIS Transformation Mappings allow the creation of custom mappings where one or more fields
 * in an EIS Record can be used to create the object to be stored in a Java class's attribute.
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Record Type Description
Indexed Ordered collection of record elements.  The indexed record EIS format
 * enables Java class attribute values to be retreived by position or index.
Mapped Key-value map based representation of record elements.  The mapped record
 * EIS format enables Java class attribute values to be retreived by an object key.
XML Record/Map representation of an XML DOM element.
 *
 * @see org.eclipse.persistence.eis.EISDescriptor#useIndexedRecordFormat
 * @see org.eclipse.persistence.eis.EISDescriptor#useMappedRecordFormat
 * @see org.eclipse.persistence.eis.EISDescriptor#useXMLRecordFormat
 *
 * @since Oracle TopLink 10g Release 2 (10.1.3)
 */
public class EISTransformationMapping extends AbstractTransformationMapping implements EISMapping {
    public EISTransformationMapping() {
        super();
    }

    /**
     * INTERNAL:
     */
    public boolean isEISMapping() {
        return true;
    }
}

Record Type	Description
Indexed	Ordered collection of record elements. The indexed record EIS format * enables Java class attribute values to be retreived by position or index.
Mapped	Key-value map based representation of record elements. The mapped record * EIS format enables Java class attribute values to be retreived by an object key.
XML	Record/Map representation of an XML DOM element.