//$Id: Hibernate.java 10009 2006-06-10 03:24:05Z epbernard $
package org.hibernate;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.io.Serializable;
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.intercept.FieldInterceptionHelper;
import org.hibernate.intercept.FieldInterceptor;
import org.hibernate.lob.BlobImpl;
import org.hibernate.lob.ClobImpl;
import org.hibernate.lob.SerializableBlob;
import org.hibernate.lob.SerializableClob;
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.usertype.CompositeUserType;
/**
* <ul>
* <li>Provides access to the full range of Hibernate built-in types. <tt>Type</tt>
* instances may be used to bind values to query parameters.
* <li>A factory for new <tt>Blob</tt>s and <tt>Clob</tt>s.
* <li>Defines static methods for manipulation of proxies.
* </ul>
*
* @author Gavin King
* @see java.sql.Clob
* @see java.sql.Blob
* @see org.hibernate.type.Type
*/
public final class Hibernate {
/**
* Hibernate <tt>long</tt> type.
*/
public static final NullableType LONG = new LongType();
/**
* Hibernate <tt>short</tt> type.
*/
public static final NullableType SHORT = new ShortType();
/**
* Hibernate <tt>integer</tt> type.
*/
public static final NullableType INTEGER = new IntegerType();
/**
* Hibernate <tt>byte</tt> type.
*/
public static final NullableType BYTE = new ByteType();
/**
* Hibernate <tt>float</tt> type.
*/
public static final NullableType FLOAT = new FloatType();
/**
* Hibernate <tt>double</tt> type.
*/
public static final NullableType DOUBLE = new DoubleType();
/**
* Hibernate <tt>character</tt> type.
*/
public static final NullableType CHARACTER = new CharacterType();
/**
* Hibernate <tt>string</tt> type.
*/
public static final NullableType STRING = new StringType();
/**
* Hibernate <tt>time</tt> type.
*/
public static final NullableType TIME = new TimeType();
/**
* Hibernate <tt>date</tt> type.
*/
public static final NullableType DATE = new DateType();
/**
* Hibernate <tt>timestamp</tt> type.
*/
public static final NullableType TIMESTAMP = new TimestampType();
/**
* Hibernate <tt>boolean</tt> type.
*/
public static final NullableType BOOLEAN = new BooleanType();
/**
* Hibernate <tt>true_false</tt> type.
*/
public static final NullableType TRUE_FALSE = new TrueFalseType();
/**
* Hibernate <tt>yes_no</tt> type.
*/
public static final NullableType YES_NO = new YesNoType();
/**
* Hibernate <tt>big_decimal</tt> type.
*/
public static final NullableType BIG_DECIMAL = new BigDecimalType();
/**
* Hibernate <tt>big_integer</tt> type.
*/
public static final NullableType BIG_INTEGER = new BigIntegerType();
/**
* Hibernate <tt>binary</tt> type.
*/
public static final NullableType BINARY = new BinaryType();
/**
* Hibernate <tt>wrapper-binary</tt> type.
*/
public static final NullableType WRAPPER_BINARY = new WrapperBinaryType();
/**
* Hibernate char[] type.
*/
public static final NullableType CHAR_ARRAY = new CharArrayType();
/**
* Hibernate Character[] type.
*/
public static final NullableType CHARACTER_ARRAY = new CharacterArrayType();
/**
* Hibernate <tt>text</tt> type.
*/
public static final NullableType TEXT = new TextType();
/**
* Hibernate <tt>blob</tt> type.
*/
public static final Type BLOB = new BlobType();
/**
* Hibernate <tt>clob</tt> type.
*/
public static final Type CLOB = new ClobType();
/**
* Hibernate <tt>calendar</tt> type.
*/
public static final NullableType CALENDAR = new CalendarType();
/**
* Hibernate <tt>calendar_date</tt> type.
*/
public static final NullableType CALENDAR_DATE = new CalendarDateType();
/**
* Hibernate <tt>locale</tt> type.
*/
public static final NullableType LOCALE = new LocaleType();
/**
* Hibernate <tt>currency</tt> type.
*/
public static final NullableType CURRENCY = new CurrencyType();
/**
* Hibernate <tt>timezone</tt> type.
*/
public static final NullableType TIMEZONE = new TimeZoneType();
/**
* Hibernate <tt>class</tt> type.
*/
public static final NullableType CLASS = new ClassType();
/**
* Hibernate <tt>serializable</tt> type.
*/
public static final NullableType SERIALIZABLE = new SerializableType( Serializable.class );
/**
* Hibernate <tt>object</tt> type.
*/
public static final Type OBJECT = new AnyType();
/**
* Cannot be instantiated.
*/
private Hibernate() {
throw new UnsupportedOperationException();
}
/**
* A Hibernate <tt>serializable</tt> type.
*/
public static Type serializable(Class serializableClass) {
return new SerializableType( serializableClass );
}
/**
* A Hibernate <tt>any</tt> type.
*
* @param metaType a type mapping <tt>java.lang.Class</tt> to a single column
* @param identifierType the entity identifier type
* @return the Type
*/
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
*/
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
*/
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 <tt>UserType</tt>
*/
public static Type custom(Class userTypeClass) throws HibernateException {
return custom( userTypeClass, null );
}
/**
* A Hibernate parameterizable custom type.
*
* @param userTypeClass a class that implements <tt>UserType and ParameterizableType</tt>
* @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.
*/
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 <tt>UserType and ParameterizableType</tt>
* @param parameters the parameters as a collection of name/value pairs
*/
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.
* <p/>
* 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 <tt>null</tt>
* @throws HibernateException if we can't initialize the proxy at this time, eg. the <tt>Session</tt> 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 <tt>null</tt>
* @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 <tt>Blob</tt>. The returned object will be initially immutable.
*
* @param bytes a byte array
* @return the Blob
*/
public static Blob createBlob(byte[] bytes) {
return new SerializableBlob( new BlobImpl( bytes ) );
}
/**
* Create a new <tt>Blob</tt>. The returned object will be initially immutable.
*
* @param stream a binary stream
* @param length the number of bytes in the stream
* @return the Blob
*/
public static Blob createBlob(InputStream stream, int length) {
return new SerializableBlob( new BlobImpl( stream, length ) );
}
/**
* Create a new <tt>Blob</tt>. The returned object will be initially immutable.
*
* @param stream a binary stream
* @return the Blob
* @throws IOException
*/
public static Blob createBlob(InputStream stream) throws IOException {
return new SerializableBlob( new BlobImpl( stream, stream.available() ) );
}
/**
* Create a new <tt>Clob</tt>. The returned object will be initially immutable.
*
* @param string a <tt>String</tt>
*/
public static Clob createClob(String string) {
return new SerializableClob( new ClobImpl( string ) );
}
/**
* Create a new <tt>Clob</tt>. The returned object will be initially immutable.
*
* @param reader a character stream
* @param length the number of characters in the stream
*/
public static Clob createClob(Reader reader, int length) {
return new SerializableClob( new ClobImpl( reader, length ) );
}
/**
* Close an <tt>Iterator</tt> created by <tt>iterate()</tt> immediately,
* instead of waiting until the session is closed or disconnected.
*
* @param iterator an <tt>Iterator</tt> created by <tt>iterate()</tt>
* @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 <tt>true</tt>.
*
* @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
* @return false if the object is an uninitialized proxy, or the named property is uninitialized
*/
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;
}
}
}
|
