org.hibernate.type.TypeFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.type;
import java.io.Serializable;
import java.lang.reflect.Constructor;
import java.util.Comparator;
import java.util.Map;
import java.util.Properties;
import org.hibernate.MappingException;
import org.hibernate.classic.Lifecycle;
import org.hibernate.engine.config.spi.ConfigurationService;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.internal.util.ReflectHelper;
import org.hibernate.tuple.component.ComponentMetamodel;
import org.hibernate.type.spi.TypeBootstrapContext;
import org.hibernate.type.spi.TypeConfiguration;
import org.hibernate.type.spi.TypeConfigurationAware;
import org.hibernate.usertype.CompositeUserType;
import org.hibernate.usertype.ParameterizedType;
import org.hibernate.usertype.UserType;
/**
* Used internally to build instances of {@link Type}, specifically it builds instances of
*
*
* Used internally to obtain instances of Type. Applications should use static methods
* and constants on org.hibernate.Hibernate.
*
* @author Gavin King
* @author Steve Ebersole
*
* @deprecated Use {@link TypeConfiguration} instead
*/
@Deprecated
@SuppressWarnings({"unchecked"})
public final class TypeFactory implements Serializable, TypeBootstrapContext {
/**
* @deprecated Use {@link TypeConfiguration}/{@link TypeConfiguration.Scope} instead
*/
@Deprecated
public interface TypeScope extends Serializable {
TypeConfiguration getTypeConfiguration();
}
private final TypeConfiguration typeConfiguration;
private final TypeScope typeScope;
public TypeFactory(TypeConfiguration typeConfiguration) {
this.typeConfiguration = typeConfiguration;
this.typeScope = (TypeScope) () -> typeConfiguration;
}
@Override
public Map getConfigurationSettings() {
return typeConfiguration.getServiceRegistry().getService( ConfigurationService.class ).getSettings();
}
public SessionFactoryImplementor resolveSessionFactory() {
return typeConfiguration.getSessionFactory();
}
public Type byClass(Class clazz, Properties parameters) {
if ( Type.class.isAssignableFrom( clazz ) ) {
return type( clazz, parameters );
}
if ( CompositeUserType.class.isAssignableFrom( clazz ) ) {
return customComponent( clazz, parameters );
}
if ( UserType.class.isAssignableFrom( clazz ) ) {
return custom( clazz, parameters );
}
if ( Lifecycle.class.isAssignableFrom( clazz ) ) {
// not really a many-to-one association *necessarily*
return manyToOne( clazz.getName() );
}
if ( Serializable.class.isAssignableFrom( clazz ) ) {
return serializable( clazz );
}
return null;
}
public Type type(Class typeClass, Properties parameters) {
try {
final Type type;
final Constructor bootstrapContextAwareTypeConstructor = ReflectHelper.getConstructor(
typeClass,
TypeBootstrapContext.class
);
if ( bootstrapContextAwareTypeConstructor != null ) {
type = bootstrapContextAwareTypeConstructor.newInstance( this );
}
else {
type = typeClass.newInstance();
}
injectParameters( type, parameters );
return type;
}
catch (Exception e) {
throw new MappingException( "Could not instantiate Type: " + typeClass.getName(), e );
}
}
// todo : can a Properties be wrapped in unmodifiable in any way?
private final static Properties EMPTY_PROPERTIES = new Properties();
public static void injectParameters(Object type, Properties parameters) {
if ( ParameterizedType.class.isInstance( type ) ) {
if ( parameters == null ) {
( (ParameterizedType) type ).setParameterValues( EMPTY_PROPERTIES );
}
else {
( (ParameterizedType) type ).setParameterValues( parameters );
}
}
else if ( parameters != null && !parameters.isEmpty() ) {
throw new MappingException( "type is not parameterized: " + type.getClass().getName() );
}
}
public CompositeCustomType customComponent(Class typeClass, Properties parameters) {
return customComponent( typeClass, parameters, typeScope );
}
/**
* @deprecated Only for use temporary use by {@link org.hibernate.Hibernate}
*/
@Deprecated
public static CompositeCustomType customComponent(
Class typeClass,
Properties parameters,
TypeScope scope) {
try {
CompositeUserType userType = typeClass.newInstance();
injectParameters( userType, parameters );
return new CompositeCustomType( userType );
}
catch (Exception e) {
throw new MappingException( "Unable to instantiate custom type: " + typeClass.getName(), e );
}
}
public CollectionType customCollection(
String typeName,
Properties typeParameters,
String role,
String propertyRef) {
Class typeClass;
try {
typeClass = ReflectHelper.classForName( typeName );
}
catch (ClassNotFoundException cnfe) {
throw new MappingException( "user collection type class not found: " + typeName, cnfe );
}
CustomCollectionType result = new CustomCollectionType( typeClass, role, propertyRef );
if ( typeParameters != null ) {
injectParameters( result.getUserType(), typeParameters );
}
return result;
}
public CustomType custom(Class typeClass, Properties parameters) {
try {
UserType userType = typeClass.newInstance();
if ( TypeConfigurationAware.class.isInstance( userType ) ) {
( (TypeConfigurationAware) userType ).setTypeConfiguration( typeConfiguration );
}
injectParameters( userType, parameters );
return new CustomType( userType );
}
catch (Exception e) {
throw new MappingException( "Unable to instantiate custom type: " + typeClass.getName(), e );
}
}
/**
* @deprecated Only for use temporary use by {@link org.hibernate.Hibernate}
*/
@Deprecated
public static CustomType custom(Class typeClass, Properties parameters, TypeScope scope) {
try {
UserType userType = typeClass.newInstance();
injectParameters( userType, parameters );
return new CustomType( userType );
}
catch (Exception e) {
throw new MappingException( "Unable to instantiate custom type: " + typeClass.getName(), e );
}
}
/**
* Build a {@link SerializableType} from the given {@link Serializable} class.
*
* @param serializableClass The {@link Serializable} class.
* @param The actual class type (extends Serializable)
*
* @return The built {@link SerializableType}
*/
public static SerializableType serializable(Class serializableClass) {
return new SerializableType( serializableClass );
}
// one-to-one type builders ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* @deprecated Use {@link TypeFactory#oneToOne(String, ForeignKeyDirection, boolean, String, boolean, boolean, String, String, boolean)}
* instead.
*/
@Deprecated
public EntityType oneToOne(
String persistentClass,
ForeignKeyDirection foreignKeyType,
boolean referenceToPrimaryKey,
String uniqueKeyPropertyName,
boolean lazy,
boolean unwrapProxy,
String entityName,
String propertyName) {
return oneToOne( persistentClass, foreignKeyType, referenceToPrimaryKey, uniqueKeyPropertyName, lazy, unwrapProxy, entityName, propertyName, foreignKeyType != ForeignKeyDirection.TO_PARENT );
}
/**
* @deprecated Use {@link TypeFactory#specialOneToOne(String, ForeignKeyDirection, boolean, String, boolean, boolean, String, String, boolean)}
* instead.
*/
@Deprecated
public EntityType specialOneToOne(
String persistentClass,
ForeignKeyDirection foreignKeyType,
boolean referenceToPrimaryKey,
String uniqueKeyPropertyName,
boolean lazy,
boolean unwrapProxy,
String entityName,
String propertyName) {
return specialOneToOne( persistentClass, foreignKeyType, referenceToPrimaryKey, uniqueKeyPropertyName, lazy, unwrapProxy, entityName, propertyName, foreignKeyType != ForeignKeyDirection.TO_PARENT );
}
public EntityType oneToOne(
String persistentClass,
ForeignKeyDirection foreignKeyType,
boolean referenceToPrimaryKey,
String uniqueKeyPropertyName,
boolean lazy,
boolean unwrapProxy,
String entityName,
String propertyName,
boolean constrained) {
return new OneToOneType(
typeScope, persistentClass, foreignKeyType, referenceToPrimaryKey,
uniqueKeyPropertyName, lazy, unwrapProxy, entityName, propertyName, constrained
);
}
public EntityType specialOneToOne(
String persistentClass,
ForeignKeyDirection foreignKeyType,
boolean referenceToPrimaryKey,
String uniqueKeyPropertyName,
boolean lazy,
boolean unwrapProxy,
String entityName,
String propertyName,
boolean constrained) {
return new SpecialOneToOneType(
typeScope, persistentClass, foreignKeyType, referenceToPrimaryKey,
uniqueKeyPropertyName, lazy, unwrapProxy, entityName, propertyName,
constrained
);
}
// many-to-one type builders ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
public EntityType manyToOne(String persistentClass) {
return new ManyToOneType( typeScope, persistentClass );
}
public EntityType manyToOne(String persistentClass, boolean lazy) {
return new ManyToOneType( typeScope, persistentClass, lazy );
}
/**
* @deprecated Use {@link #manyToOne(String, boolean, String, boolean, boolean, boolean, boolean)} instead.
*/
@Deprecated
public EntityType manyToOne(
String persistentClass,
String uniqueKeyPropertyName,
boolean lazy,
boolean unwrapProxy,
boolean ignoreNotFound,
boolean isLogicalOneToOne) {
return manyToOne(
persistentClass,
uniqueKeyPropertyName == null,
uniqueKeyPropertyName,
lazy,
unwrapProxy,
ignoreNotFound,
isLogicalOneToOne
);
}
/**
* @deprecated Use {@link #manyToOne(String, boolean, String, String, boolean, boolean, boolean, boolean)} instead.
*/
@Deprecated
public EntityType manyToOne(
String persistentClass,
boolean referenceToPrimaryKey,
String uniqueKeyPropertyName,
boolean lazy,
boolean unwrapProxy,
boolean ignoreNotFound,
boolean isLogicalOneToOne) {
return manyToOne(
persistentClass,
referenceToPrimaryKey,
uniqueKeyPropertyName,
null,
lazy,
unwrapProxy,
ignoreNotFound,
isLogicalOneToOne
);
}
public EntityType manyToOne(
String persistentClass,
boolean referenceToPrimaryKey,
String uniqueKeyPropertyName,
String propertyName,
boolean lazy,
boolean unwrapProxy,
boolean ignoreNotFound,
boolean isLogicalOneToOne) {
return new ManyToOneType(
typeScope,
persistentClass,
referenceToPrimaryKey,
uniqueKeyPropertyName,
propertyName,
lazy,
unwrapProxy,
ignoreNotFound,
isLogicalOneToOne
);
}
// collection type builders ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
public CollectionType array(String role, String propertyRef, Class elementClass) {
return new ArrayType( role, propertyRef, elementClass );
}
public CollectionType list(String role, String propertyRef) {
return new ListType( role, propertyRef );
}
public CollectionType bag(String role, String propertyRef) {
return new BagType( role, propertyRef );
}
public CollectionType idbag(String role, String propertyRef) {
return new IdentifierBagType( role, propertyRef );
}
public CollectionType map(String role, String propertyRef) {
return new MapType( role, propertyRef );
}
public CollectionType orderedMap(String role, String propertyRef) {
return new OrderedMapType( role, propertyRef );
}
public CollectionType sortedMap(String role, String propertyRef, Comparator comparator) {
return new SortedMapType( role, propertyRef, comparator );
}
public CollectionType set(String role, String propertyRef) {
return new SetType( role, propertyRef );
}
public CollectionType orderedSet(String role, String propertyRef) {
return new OrderedSetType( role, propertyRef );
}
public CollectionType sortedSet(String role, String propertyRef, Comparator comparator) {
return new SortedSetType( role, propertyRef, comparator );
}
// component type builders ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
public ComponentType component(ComponentMetamodel metamodel) {
return new ComponentType( metamodel );
}
public EmbeddedComponentType embeddedComponent(ComponentMetamodel metamodel) {
return new EmbeddedComponentType( metamodel );
}
// any type builder ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get the AnyType with the specified parameters.
*
* @param metaType meta type
* @param identifierType identifier type
* @return AnyType
* @deprecated use {@link TypeFactory#any(Type, Type, boolean)} instead
*/
@Deprecated
public Type any(Type metaType, Type identifierType) {
return any( metaType, identifierType, true );
}
/**
* Get the AnyType with the specified parameters.
*
* @param metaType meta type
* @param identifierType identifier type
* @param lazy is the underlying property lazy
* @return AnyType
*/
public Type any(Type metaType, Type identifierType, boolean lazy) {
return new AnyType( typeScope, metaType, identifierType, lazy );
}
}