org.sqlproc.engine.hibernate.HibernateSimpleSession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sql-processor-hibernate Show documentation
SQL Processor, Hibernate Module
The newest version!
package org.sqlproc.engine.hibernate;

import org.hibernate.Session;
import org.sqlproc.engine.SqlCrudEngine;
import org.sqlproc.engine.SqlProcessorException;
import org.sqlproc.engine.SqlQuery;
import org.sqlproc.engine.SqlQueryEngine;
import org.sqlproc.engine.SqlSession;

/**
 * The Hibernate stack implementation of the SQL Engine session contract. In fact it's a simple wrapper for the
 * {@link org.hibernate.Session}.
 * 
 * It's the first parameter to all primary methods in the {@link SqlQueryEngine} and {@link SqlCrudEngine}.
 * 
 * 
 * The primary contract is the method for the {@link SqlQuery} instance creation.
 * 
 * 
 * For more info please see the Tutorials.
 * 
 * @author Vladimir Hudec
 */
public class HibernateSimpleSession implements SqlSession {

    /**
     * The Hibernate Session, the first level cache and the context for all database operations.
     */
    private Session session;

    /**
     * The name of the database related to this session. It's usage is implementation specific.
     */
    private String name;

    /**
     * Creates a new instance of this dynamic proxy.
     * 
     * @param session
     *            the Hibernate Session instance
     */
    public HibernateSimpleSession(Session session) {
        this.session = session;
    }

    /**
     * Creates a new instance of this dynamic proxy.
     * 
     * @param session
     *            the Hibernate Session instance
     * @param name
     *            the name of the database
     */
    public HibernateSimpleSession(Session session, String name) {
        this(session);
        this.name = name;
    }

    /**
     * Returns the internal Hibernate Session instance.
     * 
     * @return the internal Hibernate Session instance
     */
    public Session getSession() {
        return session;
    }

    /**
     * Sets the internal Hibernate Session instance.
     * 
     * @param session
     *            the internal Hibernate Session instance
     */
    public void setSession(Session session) {
        this.session = session;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public SqlQuery createSqlQuery(String queryString) throws SqlProcessorException {
        return new HibernateQuery(session, session.createSQLQuery(queryString));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int[] executeBatch(String... statements) throws SqlProcessorException {
        SqlQuery sqlQuery = createSqlQuery(null);
        return sqlQuery.executeBatch(statements);
    }

    /**
     * @return the name of the database related to this session. It's usage is implementation specific.
     */
    public String getName() {
        return name;
    }
}