org.datanucleus.store.rdbms.mapping.MappingConsumer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of datanucleus-rdbms Show documentation

Plugin for DataNucleus providing persistence to RDBMS datastores.

There is a newer version: 6.0.8

/**********************************************************************
Copyright (c) 2004 Erik Bengtson and others. All rights reserved. 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. 
 

Contributors:
2004 Andy Jefferson - added discriminator constant
    ...
**********************************************************************/
package org.datanucleus.store.rdbms.mapping;

import org.datanucleus.metadata.AbstractMemberMetaData;
import org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping;
import org.datanucleus.store.rdbms.table.Column;

/**
 * Consumer of mappings.
 */
public interface MappingConsumer
{
    /** mapping a field representing the version of a PC **/
    public static int MAPPING_TYPE_VERSION = 1;

    /** mapping a field representing the id of a PC **/
    public static int MAPPING_TYPE_DATASTORE_ID = 2;

    /** mapping a field representing the discriminator of a PC **/
    public static int MAPPING_TYPE_DISCRIMINATOR = 3;

    /** mapping a datastore column that is an index for an external list. */
    public static int MAPPING_TYPE_EXTERNAL_INDEX = 4;

    /** mapping a datastore column that is a FK for an external collection. */
    public static int MAPPING_TYPE_EXTERNAL_FK = 5;

    /** mapping a datastore column that is the discriminator for a FK for an external collection. */
    public static int MAPPING_TYPE_EXTERNAL_FK_DISCRIM = 6;

    /** mapping a datastore column representing a multitenancy discriminator. **/
    public static int MAPPING_TYPE_MULTITENANCY = 7;

    /**
     * This method is called before consuming the mappings
     * @param highestFieldNumber the highest number for the fields that are going to be provided in the consumer
     */
    void preConsumeMapping(int highestFieldNumber);

    /**
     * Consumes a mapping associated to a field
     * @param m The Java type mapping
     * @param fmd Field MetaData for the field
     */
    void consumeMapping(JavaTypeMapping m, AbstractMemberMetaData fmd);

    /**
     * Consumes a mapping not associated to a field
     * @param m Java type mapping
     * @param mappingType the Mapping type
     */
    void consumeMapping(JavaTypeMapping m, int mappingType);

    /**
     * Consume a column without mapping.
     * @param col The column
     */
    void consumeUnmappedColumn(Column col);
}