Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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 java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.io.Serializable;
import java.io.ByteArrayOutputStream;
import java.sql.Blob;
import java.sql.Clob;
import java.util.Iterator;
import java.util.Properties;
import org.hibernate.collection.PersistentCollection;
import org.hibernate.engine.HibernateIterator;
import org.hibernate.engine.SessionImplementor;
import org.hibernate.engine.jdbc.NonContextualLobCreator;
import org.hibernate.engine.jdbc.LobCreationContext;
import org.hibernate.engine.jdbc.LobCreator;
import org.hibernate.engine.jdbc.StreamUtils;
import org.hibernate.intercept.FieldInterceptionHelper;
import org.hibernate.intercept.FieldInterceptor;
import org.hibernate.proxy.HibernateProxy;
import org.hibernate.proxy.LazyInitializer;
import org.hibernate.type.AnyType;
import org.hibernate.type.BigDecimalType;
import org.hibernate.type.BigIntegerType;
import org.hibernate.type.BinaryType;
import org.hibernate.type.BlobType;
import org.hibernate.type.BooleanType;
import org.hibernate.type.ByteType;
import org.hibernate.type.CalendarDateType;
import org.hibernate.type.CalendarType;
import org.hibernate.type.CharacterType;
import org.hibernate.type.ClassType;
import org.hibernate.type.ClobType;
import org.hibernate.type.CompositeCustomType;
import org.hibernate.type.CurrencyType;
import org.hibernate.type.CustomType;
import org.hibernate.type.DateType;
import org.hibernate.type.DoubleType;
import org.hibernate.type.FloatType;
import org.hibernate.type.IntegerType;
import org.hibernate.type.LocaleType;
import org.hibernate.type.LongType;
import org.hibernate.type.ManyToOneType;
import org.hibernate.type.NullableType;
import org.hibernate.type.SerializableType;
import org.hibernate.type.ShortType;
import org.hibernate.type.StringType;
import org.hibernate.type.TextType;
import org.hibernate.type.TimeType;
import org.hibernate.type.TimeZoneType;
import org.hibernate.type.TimestampType;
import org.hibernate.type.TrueFalseType;
import org.hibernate.type.Type;
import org.hibernate.type.YesNoType;
import org.hibernate.type.CharArrayType;
import org.hibernate.type.WrapperBinaryType;
import org.hibernate.type.CharacterArrayType;
import org.hibernate.type.MaterializedBlobType;
import org.hibernate.type.ImageType;
import org.hibernate.type.MaterializedClobType;
import org.hibernate.usertype.CompositeUserType;
/**
*
*
Provides access to the full range of Hibernate built-in types. Type
* instances may be used to bind values to query parameters.
*
A factory for new Blobs and Clobs.
*
Defines static methods for manipulation of proxies.
*
*
* @author Gavin King
* @see java.sql.Clob
* @see java.sql.Blob
* @see org.hibernate.type.Type
*/
public final class Hibernate {
/**
* Hibernate long type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType LONG = new LongType();
/**
* Hibernate short type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType SHORT = new ShortType();
/**
* Hibernate integer type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType INTEGER = new IntegerType();
/**
* Hibernate byte type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType BYTE = new ByteType();
/**
* Hibernate float type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType FLOAT = new FloatType();
/**
* Hibernate double type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType DOUBLE = new DoubleType();
/**
* Hibernate character type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CHARACTER = new CharacterType();
/**
* Hibernate string type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType STRING = new StringType();
/**
* Hibernate time type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType TIME = new TimeType();
/**
* Hibernate date type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType DATE = new DateType();
/**
* Hibernate timestamp type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType TIMESTAMP = new TimestampType();
/**
* Hibernate boolean type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType BOOLEAN = new BooleanType();
/**
* Hibernate true_false type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType TRUE_FALSE = new TrueFalseType();
/**
* Hibernate yes_no type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType YES_NO = new YesNoType();
/**
* Hibernate big_decimal type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType BIG_DECIMAL = new BigDecimalType();
/**
* Hibernate big_integer type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType BIG_INTEGER = new BigIntegerType();
/**
* Hibernate binary type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType BINARY = new BinaryType();
/**
* Hibernate wrapper-binary type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType WRAPPER_BINARY = new WrapperBinaryType();
/**
* Hibernate char[] type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CHAR_ARRAY = new CharArrayType();
/**
* Hibernate Character[] type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CHARACTER_ARRAY = new CharacterArrayType();
/**
* Hibernate image type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType IMAGE = new ImageType();
/**
* Hibernate text type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType TEXT = new TextType();
/**
* Hibernate materialized_blob type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType MATERIALIZED_BLOB = new MaterializedBlobType();
/**
* Hibernate materialized_clob type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType MATERIALIZED_CLOB = new MaterializedClobType();
/**
* Hibernate blob type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final Type BLOB = new BlobType();
/**
* Hibernate clob type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final Type CLOB = new ClobType();
/**
* Hibernate calendar type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CALENDAR = new CalendarType();
/**
* Hibernate calendar_date type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CALENDAR_DATE = new CalendarDateType();
/**
* Hibernate locale type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType LOCALE = new LocaleType();
/**
* Hibernate currency type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CURRENCY = new CurrencyType();
/**
* Hibernate timezone type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType TIMEZONE = new TimeZoneType();
/**
* Hibernate class type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType CLASS = new ClassType();
/**
* Hibernate serializable type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final NullableType SERIALIZABLE = new SerializableType( Serializable.class );
/**
* Hibernate object type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static final Type OBJECT = new AnyType();
/**
* Cannot be instantiated.
*/
private Hibernate() {
throw new UnsupportedOperationException();
}
/**
* A Hibernate serializable type.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5138
*/
public static Type serializable(Class serializableClass) {
return new SerializableType( serializableClass );
}
/**
* A Hibernate any type.
*
* @param metaType a type mapping java.lang.Class to a single column
* @param identifierType the entity identifier type
* @return the Type
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5182
*/
public static Type any(Type metaType, Type identifierType) {
return new AnyType( metaType, identifierType );
}
/**
* A Hibernate persistent object (entity) type.
*
* @param persistentClass a mapped entity class
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5182
*/
public static Type entity(Class persistentClass) {
// not really a many-to-one association *necessarily*
return new ManyToOneType( persistentClass.getName() );
}
/**
* A Hibernate persistent object (entity) type.
*
* @param entityName a mapped entity class
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5182
*/
public static Type entity(String entityName) {
// not really a many-to-one association *necessarily*
return new ManyToOneType( entityName );
}
/**
* A Hibernate custom type.
*
* @param userTypeClass a class that implements UserType
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5182
*/
public static Type custom(Class userTypeClass) throws HibernateException {
return custom( userTypeClass, null );
}
/**
* A Hibernate parameterizable custom type.
*
* @param userTypeClass a class that implements UserType and ParameterizableType
* @param parameterNames the names of the parameters passed to the type
* @param parameterValues the values of the parameters passed to the type. They must match
* up with the order and length of the parameterNames array.
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5182
*/
public static Type custom(Class userTypeClass, String[] parameterNames, String[] parameterValues)
throws HibernateException {
Properties parameters = new Properties();
for ( int i = 0; i < parameterNames.length; i++ ) {
parameters.setProperty( parameterNames[i], parameterValues[i] );
}
return custom( userTypeClass, parameters );
}
/**
* A Hibernate parameterizable custom type.
*
* @param userTypeClass a class that implements UserType and ParameterizableType
* @param parameters the parameters as a collection of name/value pairs
*
* @deprecated see http://opensource.atlassian.com/projects/hibernate/browse/HHH-5182
*/
public static Type custom(Class userTypeClass, Properties parameters)
throws HibernateException {
if ( CompositeUserType.class.isAssignableFrom( userTypeClass ) ) {
CompositeCustomType type = new CompositeCustomType( userTypeClass, parameters );
return type;
}
else {
CustomType type = new CustomType( userTypeClass, parameters );
return type;
}
}
/**
* Force initialization of a proxy or persistent collection.
*
* Note: This only ensures intialization of a proxy object or collection;
* it is not guaranteed that the elements INSIDE the collection will be initialized/materialized.
*
* @param proxy a persistable object, proxy, persistent collection or null
* @throws HibernateException if we can't initialize the proxy at this time, eg. the Session was closed
*/
public static void initialize(Object proxy) throws HibernateException {
if ( proxy == null ) {
return;
}
else if ( proxy instanceof HibernateProxy ) {
( ( HibernateProxy ) proxy ).getHibernateLazyInitializer().initialize();
}
else if ( proxy instanceof PersistentCollection ) {
( ( PersistentCollection ) proxy ).forceInitialization();
}
}
/**
* Check if the proxy or persistent collection is initialized.
*
* @param proxy a persistable object, proxy, persistent collection or null
* @return true if the argument is already initialized, or is not a proxy or collection
*/
public static boolean isInitialized(Object proxy) {
if ( proxy instanceof HibernateProxy ) {
return !( ( HibernateProxy ) proxy ).getHibernateLazyInitializer().isUninitialized();
}
else if ( proxy instanceof PersistentCollection ) {
return ( ( PersistentCollection ) proxy ).wasInitialized();
}
else {
return true;
}
}
/**
* Get the true, underlying class of a proxied persistent class. This operation
* will initialize a proxy by side-effect.
*
* @param proxy a persistable object or proxy
* @return the true class of the instance
* @throws HibernateException
*/
public static Class getClass(Object proxy) {
if ( proxy instanceof HibernateProxy ) {
return ( ( HibernateProxy ) proxy ).getHibernateLazyInitializer()
.getImplementation()
.getClass();
}
else {
return proxy.getClass();
}
}
/**
* Create a new {@link Blob}. The returned object will be initially immutable.
*
* @param bytes a byte array
* @return the Blob
* @deprecated Use {@link #createBlob(byte[], Session)} instead
*/
public static Blob createBlob(byte[] bytes) {
return NonContextualLobCreator.INSTANCE.wrap(
NonContextualLobCreator.INSTANCE.createBlob( bytes )
);
}
/**
* Create a new {@link Blob}.
*
* @param bytes a byte array
* @param session The session in which the {@link Blob} will be used.
* @return the Blob
*/
public static Blob createBlob(byte[] bytes, Session session) {
// todo : wrap?
return getLobCreator( session ).createBlob( bytes );
}
public static LobCreator getLobCreator(Session session) {
return getLobCreator( ( SessionImplementor ) session );
}
public static LobCreator getLobCreator(SessionImplementor session) {
return session.getFactory()
.getSettings()
.getJdbcSupport()
.getLobCreator( ( LobCreationContext ) session );
}
/**
* Create a new {@link Blob}. The returned object will be initially immutable.
*
* @param stream a binary stream
* @param length the number of bytes in the stream
* @return the Blob
* @deprecated Use {@link #createBlob(InputStream, long, Session)} instead
*/
public static Blob createBlob(InputStream stream, int length) {
return NonContextualLobCreator.INSTANCE.wrap(
NonContextualLobCreator.INSTANCE.createBlob( stream, length )
);
}
/**
* Create a new {@link Blob}. The returned object will be initially immutable.
*
* @param stream a binary stream
* @param length the number of bytes in the stream
* @return the Blob
* @deprecated Use {@link #createBlob(InputStream, long, Session)} instead
*/
public static Blob createBlob(InputStream stream, long length) {
return NonContextualLobCreator.INSTANCE.wrap(
NonContextualLobCreator.INSTANCE.createBlob( stream, length )
);
}
/**
* Create a new {@link Blob}.
*
* @param stream a binary stream
* @param length the number of bytes in the stream
* @param session The session in which the {@link Blob} will be used.
* @return the Blob
*/
public static Blob createBlob(InputStream stream, long length, Session session) {
// todo : wrap?
return getLobCreator( session ).createBlob( stream, length );
}
/**
* Create a new {@link Blob}. The returned object will be initially immutable.
*
* NOTE: this method will read the entire contents of the incoming stream in order to properly
* handle the {@link Blob#length()} method. If you do not want the stream read, use the
* {@link #createBlob(InputStream,long)} version instead.
*
* @param stream a binary stream
* @return the Blob
* @throws IOException Indicates an I/O problem accessing the stream
* @deprecated Use {@link #createBlob(InputStream, long, Session)} instead
*/
public static Blob createBlob(InputStream stream) throws IOException {
ByteArrayOutputStream buffer = new ByteArrayOutputStream( stream.available() );
StreamUtils.copy( stream, buffer );
return createBlob( buffer.toByteArray() );
}
/**
* Create a new {@link Clob}. The returned object will be initially immutable.
*
* @param string The string data
* @return The created {@link Clob}
* @deprecated Use {@link #createClob(String, Session)} instead
*/
public static Clob createClob(String string) {
return NonContextualLobCreator.INSTANCE.wrap(
NonContextualLobCreator.INSTANCE.createClob( string )
);
}
/**
* Create a new {@link Clob}.
*
* @param string The string data
* @param session The session in which the {@link Clob} will be used.
* @return The created {@link Clob}
*/
public static Clob createClob(String string, Session session) {
// todo : wrap?
return getLobCreator( session ).createClob( string );
}
/**
* Create a new {@link Clob}. The returned object will be initially immutable.
*
* @param reader a character stream
* @param length the number of characters in the stream
* @return The created {@link Clob}
* @deprecated Use {@link #createClob(Reader,long,Session)} instead
*/
public static Clob createClob(Reader reader, int length) {
return NonContextualLobCreator.INSTANCE.wrap(
NonContextualLobCreator.INSTANCE.createClob( reader, length )
);
}
/**
* Create a new {@link Clob}. The returned object will be initially immutable.
*
* @param reader a character stream
* @param length the number of characters in the stream
* @return The created {@link Clob}
* @deprecated Use {@link #createClob(Reader,long,Session)} instead
*/
public static Clob createClob(Reader reader, long length) {
return NonContextualLobCreator.INSTANCE.wrap(
NonContextualLobCreator.INSTANCE.createClob( reader, length )
);
}
/**
* Create a new {@link Clob}.
*
* @param reader a character stream
* @param length the number of characters in the stream
* @param session The session in which the {@link Clob} will be used.
* @return The created {@link Clob}
*/
public static Clob createClob(Reader reader, long length, Session session) {
return getLobCreator( session ).createClob( reader, length );
}
/**
* Close an Iterator created by iterate() immediately,
* instead of waiting until the session is closed or disconnected.
*
* @param iterator an Iterator created by iterate()
* @throws HibernateException
* @see org.hibernate.Query#iterate
* @see Query#iterate()
*/
public static void close(Iterator iterator) throws HibernateException {
if ( iterator instanceof HibernateIterator ) {
( ( HibernateIterator ) iterator ).close();
}
else {
throw new IllegalArgumentException( "not a Hibernate iterator" );
}
}
/**
* Check if the property is initialized. If the named property does not exist
* or is not persistent, this method always returns true.
*
* @param proxy The potential proxy
* @param propertyName the name of a persistent attribute of the object
* @return true if the named property of the object is not listed as uninitialized; false otherwise
*/
public static boolean isPropertyInitialized(Object proxy, String propertyName) {
Object entity;
if ( proxy instanceof HibernateProxy ) {
LazyInitializer li = ( ( HibernateProxy ) proxy ).getHibernateLazyInitializer();
if ( li.isUninitialized() ) {
return false;
}
else {
entity = li.getImplementation();
}
}
else {
entity = proxy;
}
if ( FieldInterceptionHelper.isInstrumented( entity ) ) {
FieldInterceptor interceptor = FieldInterceptionHelper.extractFieldInterceptor( entity );
return interceptor == null || interceptor.isInitialized( propertyName );
}
else {
return true;
}
}
}
