FileDocCategorySizeDatePackage
Session.javaAPI DocHibernate 3.2.514579Fri Mar 17 11:59:04 GMT 2006org.hibernate.classic

Session

public interface Session implements org.hibernate.Session
An extension of the Session API, including all deprecated methods from Hibernate2. This interface is provided to allow easier migration of existing applications. New code should use org.hibernate.Session.
author
Gavin King

Fields Summary
Constructors Summary
Methods Summary
public org.hibernate.QuerycreateSQLQuery(java.lang.String sql, java.lang.String returnAlias, java.lang.Class returnClass)
Create a new instance of Query for the given SQL string.

deprecated
will be replaced with a more Query like interface in later release
param
sql a query expressed in SQL
param
returnAlias a table alias that appears inside {} in the SQL string
param
returnClass the returned persistent class

public org.hibernate.QuerycreateSQLQuery(java.lang.String sql, java.lang.String[] returnAliases, java.lang.Class[] returnClasses)
Create a new instance of Query for the given SQL string.

deprecated
will be replaced with a more Query like interface in later release
param
sql a query expressed in SQL
param
returnAliases an array of table aliases that appear inside {} in the SQL string
param
returnClasses the returned persistent classes

public intdelete(java.lang.String query)
Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling {@link #delete(Object)} individually.

deprecated
consider using HQL delete statements
param
query the query string
return
the number of instances deleted
throws
HibernateException

public intdelete(java.lang.String query, java.lang.Object value, org.hibernate.type.Type type)
Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling {@link #delete(Object)} individually.

deprecated
consider using HQL delete statements
param
query the query string
param
value a value to be witten to a "?" placeholder in the query string.
param
type the hibernate type of value.
return
the number of instances deleted
throws
HibernateException

public intdelete(java.lang.String query, java.lang.Object[] values, org.hibernate.type.Type[] types)
Delete all objects returned by the query. Return the number of objects deleted.

Note that this is very different from the delete-statement support added in HQL since 3.1. The functionality here is to actually peform the query and then iterate the results calling {@link #delete(Object)} individually.

deprecated
consider using HQL delete statements
param
query the query string
param
values a list of values to be written to "?" placeholders in the query.
param
types a list of Hibernate types of the values
return
the number of instances deleted
throws
HibernateException

public java.util.Collectionfilter(java.lang.Object collection, java.lang.String filter)
Apply a filter to a persistent collection. A filter is a Hibernate query that may refer to this, the collection element. Filters allow efficient access to very large lazy collections. (Executing the filter does not initialize the collection.)

deprecated
use {@link #createFilter(Object, String)}.{@link Query#list}
param
collection a persistent collection to filter
param
filter a filter query string
return
Collection the resulting collection
throws
HibernateException

public java.util.Collectionfilter(java.lang.Object collection, java.lang.String filter, java.lang.Object value, org.hibernate.type.Type type)
Apply a filter to a persistent collection. A filter is a Hibernate query that may refer to this, the collection element.

deprecated
use {@link #createFilter(Object, String)}.setXYZ.{@link Query#list}
param
collection a persistent collection to filter
param
filter a filter query string
param
value a value to be witten to a "?" placeholder in the query string
param
type the hibernate type of value
return
Collection
throws
HibernateException

public java.util.Collectionfilter(java.lang.Object collection, java.lang.String filter, java.lang.Object[] values, org.hibernate.type.Type[] types)
Apply a filter to a persistent collection. Bind the given parameters to "?" placeholders. A filter is a Hibernate query that may refer to this, the collection element.

deprecated
use {@link #createFilter(Object, String)}.setXYZ.{@link Query#list}
param
collection a persistent collection to filter
param
filter a filter query string
param
values a list of values to be written to "?" placeholders in the query
param
types a list of Hibernate types of the values
return
Collection
throws
HibernateException

public java.util.Listfind(java.lang.String query)
Execute a query.

deprecated
use {@link #createQuery}.{@link Query#list()}
param
query a query expressed in Hibernate's query language
return
a distinct list of instances (or arrays of instances)
throws
HibernateException

public java.util.Listfind(java.lang.String query, java.lang.Object value, org.hibernate.type.Type type)
Execute a query with bind parameters, binding a value to a "?" parameter in the query string.

deprecated
use {@link #createQuery}.setXYZ.{@link Query#list()}
param
query the query string
param
value a value to be bound to a "?" placeholder (JDBC IN parameter).
param
type the Hibernate type of the value
see
org.hibernate.Hibernate for access to Type instances
return
a distinct list of instances (or arrays of instances)
throws
HibernateException

public java.util.Listfind(java.lang.String query, java.lang.Object[] values, org.hibernate.type.Type[] types)
Execute a query with bind parameters, binding an array of values to "?" parameters in the query string.

deprecated
use {@link #createQuery}.setXYZ.{@link Query#list()}
param
query the query string
param
values an array of values to be bound to the "?" placeholders (JDBC IN parameters).
param
types an array of Hibernate types of the values
see
org.hibernate.Hibernate for access to Type instances
return
a distinct list of instances
throws
HibernateException

public java.util.Iteratoriterate(java.lang.String query, java.lang.Object[] values, org.hibernate.type.Type[] types)
Execute a query and return the results in an iterator. Write the given values to "?" in the query string. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

deprecated
use {@link #createQuery}.setXYZ.{@link Query#iterate}
param
query the query string
param
values a list of values to be written to "?" placeholders in the query
param
types a list of Hibernate types of the values
return
an iterator
throws
HibernateException

public java.util.Iteratoriterate(java.lang.String query)
Execute a query and return the results in an iterator. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

deprecated
use {@link #createQuery}.{@link Query#iterate}
param
query the query string
return
an iterator
throws
HibernateException

public java.util.Iteratoriterate(java.lang.String query, java.lang.Object value, org.hibernate.type.Type type)
Execute a query and return the results in an iterator. Write the given value to "?" in the query string. If the query has multiple return values, values will be returned in an array of type Object[].

Entities returned as results are initialized on demand. The first SQL query returns identifiers only. So iterate() is usually a less efficient way to retrieve objects than find().

deprecated
use {@link #createQuery}.setXYZ.{@link Query#iterate}
param
query the query string
param
value a value to be witten to a "?" placeholder in the query string
param
type the hibernate type of value
return
an iterator
throws
HibernateException

public voidsave(java.lang.Object object, java.io.Serializable id)
Persist the given transient instance, using the given identifier. This operation cascades to associated instances if the association is mapped with cascade="save-update".

deprecated
declare identifier properties for all classes
param
object a transient instance of a persistent class
param
id an unused valid identifier
throws
HibernateException

public voidsave(java.lang.String entityName, java.lang.Object object, java.io.Serializable id)
Persist the given transient instance, using the given identifier. This operation cascades to associated instances if the association is mapped with cascade="save-update".

deprecated
declare identifier properties for all classes
param
object a transient instance of a persistent class
param
id an unused valid identifier
throws
HibernateException

public java.lang.ObjectsaveOrUpdateCopy(java.lang.Object object)
Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved or does not exist in the database, save it and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

deprecated
use {@link org.hibernate.Session#merge(Object)}
param
object a transient instance with state to be copied
return
an updated persistent instance

public java.lang.ObjectsaveOrUpdateCopy(java.lang.Object object, java.io.Serializable id)
Copy the state of the given object onto the persistent object with the given identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If there is no database row with the given identifier, save the given instance and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

deprecated
with no replacement
param
object a persistent or transient instance with state to be copied
param
id the identifier of the instance to copy to
return
an updated persistent instance

public java.lang.ObjectsaveOrUpdateCopy(java.lang.String entityName, java.lang.Object object)
Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved or does not exist in the database, save it and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

deprecated
use {@link org.hibernate.Session#merge(String, Object)}
param
object a transient instance with state to be copied
return
an updated persistent instance

public java.lang.ObjectsaveOrUpdateCopy(java.lang.String entityName, java.lang.Object object, java.io.Serializable id)
Copy the state of the given object onto the persistent object with the given identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If there is no database row with the given identifier, save the given instance and return it as a newly persistent instance. Otherwise, the given instance does not become associated with the session.

deprecated
with no replacement
param
object a persistent or transient instance with state to be copied
param
id the identifier of the instance to copy to
return
an updated persistent instance

public voidupdate(java.lang.Object object, java.io.Serializable id)
Update the persistent state associated with the given identifier. An exception is thrown if there is a persistent instance with the same identifier in the current session. This operation cascades to associated instances if the association is mapped with cascade="save-update".

deprecated
declare identifier properties for all classes
param
object a detached instance containing updated state
param
id identifier of persistent instance
throws
HibernateException

public voidupdate(java.lang.String entityName, java.lang.Object object, java.io.Serializable id)
Update the persistent state associated with the given identifier. An exception is thrown if there is a persistent instance with the same identifier in the current session. This operation cascades to associated instances if the association is mapped with cascade="save-update".

deprecated
declare identifier properties for all classes
param
object a detached instance containing updated state
param
id identifier of persistent instance
throws
HibernateException