com.github.molcikas.photon.blueprints.CompoundEntityFieldValueMapping Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of photon-core Show documentation

null

There is a newer version: 0.10.2

package com.github.molcikas.photon.blueprints;

import java.util.Map;

/**
 * Interface for custom mapping a group of database values to and from one or more entity fields.
 *
 * @param  - The entity class type
 */
public interface CompoundEntityFieldValueMapping
{
    /**
     * Get the database values from a given entity instance.
     *
     * @param entityInstance - The entity instance
     * @return - The database values. The key is the column name and the value is the database value.
     */
    Map getDatabaseValues(E entityInstance);

    /**
     * Set a given set of database values on a given entity instance.
     *
     * @param entityInstance - The entity instance
     * @param databaseValues - The database values. The key is the column name and the value is the database value.
     * @return - The field values to set on the entity. The key is the field name and the value is the field value. If
     *           the values were applied directly to the entity instance, then null or an empty map can be returned.
     */
    Map setFieldValues(E entityInstance, Map databaseValues);
}