org.hibernate.type.TypeResolver Maven / Gradle / Ivy
/*
* 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.util.Properties;
import org.hibernate.MappingException;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.internal.util.ReflectHelper;
import org.hibernate.usertype.CompositeUserType;
import org.hibernate.usertype.UserType;
/**
* Acts as the contract for getting types and as the mediator between {@link BasicTypeRegistry} and {@link TypeFactory}.
*
* @author Steve Ebersole
*/
public class TypeResolver implements Serializable {
private final BasicTypeRegistry basicTypeRegistry;
private final TypeFactory typeFactory;
public TypeResolver() {
this( new BasicTypeRegistry(), new TypeFactory() );
}
public TypeResolver(BasicTypeRegistry basicTypeRegistry, TypeFactory typeFactory) {
this.basicTypeRegistry = basicTypeRegistry;
this.typeFactory = typeFactory;
}
public TypeResolver scope(SessionFactoryImplementor factory) {
typeFactory.injectSessionFactory( factory );
return new TypeResolver( basicTypeRegistry.shallowCopy(), typeFactory );
}
public void registerTypeOverride(BasicType type) {
basicTypeRegistry.register( type );
}
public void registerTypeOverride(UserType type, String[] keys) {
basicTypeRegistry.register( type, keys );
}
public void registerTypeOverride(CompositeUserType type, String[] keys) {
basicTypeRegistry.register( type, keys );
}
public TypeFactory getTypeFactory() {
return typeFactory;
}
/**
* Locate a Hibernate {@linkplain BasicType basic type} given (one of) its registration names.
*
* @param name The registration name
*
* @return The registered type
*/
public BasicType basic(String name) {
return basicTypeRegistry.getRegisteredType( name );
}
/**
* See {@link #heuristicType(String, Properties)}
*
* @param typeName The name (see heuristic algorithm discussion on {@link #heuristicType(String, Properties)}).
*
* @return The deduced type; may be null.
*
* @throws MappingException Can be thrown from {@link #heuristicType(String, Properties)}
*/
public Type heuristicType(String typeName) throws MappingException {
return heuristicType( typeName, null );
}
/**
* Uses heuristics to deduce the proper {@link Type} given a string naming the type or Java class.
*
* The search goes as follows:
* - search for a basic type with 'typeName' as a registration key
* -
* look for 'typeName' as a class name and
* - if it names a {@link Type} implementor, return an instance
* - if it names a {@link CompositeUserType} or a {@link UserType}, return an instance of class wrapped intot the appropriate {@link Type} adapter
* - if it implements {@link org.hibernate.classic.Lifecycle}, return the corresponding entity type
* - if it implements {@link Serializable}, return the corresponding serializable type
*
*
*
*
* @param typeName The name (see heuristic algorithm above).
* @param parameters Any parameters for the type. Only applied if built!
*
* @return The deduced type; may be null.
*
* @throws MappingException Indicates a problem attempting to resolve 'typeName' as a {@link Class}
*/
public Type heuristicType(String typeName, Properties parameters) throws MappingException {
Type type = basic( typeName );
if ( type != null ) {
return type;
}
try {
Class typeClass = ReflectHelper.classForName( typeName );
if ( typeClass != null ) {
return typeFactory.byClass( typeClass, parameters );
}
}
catch ( ClassNotFoundException ignore ) {
}
return null;
}
}