com.revolsys.orm.hibernate.callback.HibernateNamedQueryCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.revolsys.open.orm.hibernate Show documentation

The newest version!

/*
 * Copyright 2004-2005 Revolution Systems Inc.
 * 
 * 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.
 */
package com.revolsys.orm.hibernate.callback;

import java.sql.SQLException;

import org.hibernate.Query;
import org.hibernate.Session;
import org.springframework.orm.hibernate3.HibernateCallback;

/**
 * The HibernateNamedQueryCallback is designed to execute the hibernate
 * {@link Session#getNamedQuery(java.lang.String)} method within a spring
 * framework
 * {@link org.springframework.orm.hibernate3.HibernateTemplate#execute(org.springframework.orm.hibernate3.HibernateCallback)}
 * method.
 * 
 * @author Paul Austin
 */
public class HibernateNamedQueryCallback implements HibernateCallback {
  /** The name of the query. */
  private final String queryName;

  /**
   * Construct a new HibernateNamedQueryCallback.
   * 
   * @param queryName The name of the query.
   */
  public HibernateNamedQueryCallback(final String queryName) {
    this.queryName = queryName;
  }

  /**
   * Perform the action.
   * 
   * @param session The Hibernate session.
   * @return The result of the action.
   * @throws SQLException If a SQL exception occurs.
   */
  public Query doInHibernate(final Session session) throws SQLException {
    return session.getNamedQuery(queryName);
  }
}