org.openmrs.api.db.hibernate.NativeIfNotAssignedIdentityGenerator.java Source code

Introduction

Here is the source code for org.openmrs.api.db.hibernate.NativeIfNotAssignedIdentityGenerator.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.api.db.hibernate;

import java.io.Serializable;
import java.util.Properties;

import org.hibernate.HibernateException;
import org.hibernate.MappingException;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.id.Configurable;
import org.hibernate.id.IdentityGenerator;
import org.hibernate.persister.entity.EntityPersister;
import org.hibernate.type.Type;

/**
 * <b>native-if-not-assigned</b><br>
 * <br>
 * By setting the Hibernate configuration's primary key column to use a "native" implementation,
 * Hibernate ALWAYS generates the entity's id when it is being saved. There is no way to "override"
 * the generated id. <br>
 * <br>
 * This IdentityGenerator allows a programmer to override the "generated" id, with an "assigned" id
 * at runtime by simply setting the primary key property.
 * 
 * @author paul.shemansky@gmail.com
 */
public class NativeIfNotAssignedIdentityGenerator extends IdentityGenerator implements Configurable {

    private String entityName;

    @Override
    public Serializable generate(SessionImplementor session, Object entity) throws HibernateException {
        Serializable id;
        EntityPersister persister = session.getEntityPersister(entityName, entity);
        // Determine if an ID has been assigned.
        id = persister.getIdentifier(entity, session);
        if (id == null) {
            id = super.generate(session, entity);
        }
        return id;
    }

    /**
     * @see org.hibernate.id.Configurable#configure(org.hibernate.type.Type, java.util.Properties,
     *      org.hibernate.dialect.Dialect)
     */
    public void configure(Type type, Properties params, Dialect dialect) throws MappingException {
        this.entityName = params.getProperty(ENTITY_NAME);
        if (entityName == null) {
            throw new MappingException("no entity name");
        }
    }

}