SQLQuery.java :  » Database-ORM » hibernate » org » hibernate » Java Open Source

Java Open Source » Database ORM » hibernate 
hibernate » org » hibernate » SQLQuery.java
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Middleware LLC.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 */
package org.hibernate;

import org.hibernate.type.Type;

/**
 * Allows the user to declare the types and select list injection
 * points of all entities returned by the query. Also allows
 * declaration of the type and column alias of any scalar results
 * of the query.
 * 
 * @author Gavin King
 */
public interface SQLQuery extends Query {
  /**
   * Declare a "root" entity, without specifying an alias
   */
  public SQLQuery addEntity(String entityName);
  /**
   * Declare a "root" entity
   */
  public SQLQuery addEntity(String alias, String entityName);
  /**
   * Declare a "root" entity, specifying a lock mode
   */
  public SQLQuery addEntity(String alias, String entityName, LockMode lockMode);
  /**
   * Declare a "root" entity, without specifying an alias
   */
  public SQLQuery addEntity(Class entityClass);
  /**
   * Declare a "root" entity
   */
  public SQLQuery addEntity(String alias, Class entityClass);
  /**
   * Declare a "root" entity, specifying a lock mode
   */
  public SQLQuery addEntity(String alias, Class entityClass, LockMode lockMode);

  /**
   * Declare a "joined" entity
   */
  public SQLQuery addJoin(String alias, String path);
  /**
   * Declare a "joined" entity, specifying a lock mode
   */
  public SQLQuery addJoin(String alias, String path, LockMode lockMode);
  
  /**
   * Declare a scalar query result
   */
  public SQLQuery addScalar(String columnAlias, Type type);

  /**
   * Declare a scalar query. Hibernate will attempt to automatically detect the underlying type.
   */
  public SQLQuery addScalar(String columnAlias);

  /**
   * Use a predefined named ResultSetMapping
   */
  public SQLQuery setResultSetMapping(String name);

  /**
   * Adds a query space for auto-flush synchronization.
   *
   * @param querySpace The query space to be auto-flushed for this query.
   * @return this, for method chaning
   */
  public SQLQuery addSynchronizedQuerySpace(String querySpace);

  /**
   * Adds an entity name or auto-flush synchronization.
   *
   * @param entityName The name of the entity upon whose defined
   * query spaces we should additionally synchronize.
   * @return this, for method chaning
   * @throws MappingException Indicates the given entity name could not be
   * resolved.
   */
  public SQLQuery addSynchronizedEntityName(String entityName) throws MappingException;

  /**
   * Adds an entity name or auto-flush synchronization.
   *
   * @param entityClass The class of the entity upon whose defined
   * query spaces we should additionally synchronize.
   * @return this, for method chaning
   * @throws MappingException Indicates the given entity class could not be
   * resolved.
   */
  public SQLQuery addSynchronizedEntityClass(Class entityClass) throws MappingException;
}
java2s.com  | Contact Us | Privacy Policy
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.