Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-10317 - Allow to bind custom types that implement the Collection interface through JPA APIs 

(cherry picked from commit 13a169c599)
This commit is contained in:
Steve Ebersole 2016-01-12 17:43:49 -06:00
parent 9f7b993f8c
commit af79fccb9d
4 changed files with 294 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
hibernate-entitymanager/src/main/java/org/hibernate/jpa/TypedParameterValue.java Normal file
View File

@ -0,0 +1,43 @@
/*
* 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.jpa;
import org.hibernate.type.Type;
/**
* Can be used to bind query parameter values. Allows to provide additional details about the
* parameter value/binding.
*
* @author Steve Ebersole
*/
public class TypedParameterValue {
private final Type type;
private final Object value;
public TypedParameterValue(Type type, Object value) {
this.type = type;
this.value = value;
}
/**
* The value to bind
*
* @return The value to be bound
*/
public Object getValue() {
return value;
}
/**
* The specific Hibernate type to use to bind the value.
*
* @return The Hibernate type to use.
*/
public Type getType() {
return type;
}
}

19
hibernate-entitymanager/src/main/java/org/hibernate/jpa/internal/QueryImpl.java
View File

@ -36,13 +36,13 @@ import org.hibernate.hql.internal.QueryExecutionRequestException;
import org.hibernate.internal.SQLQueryImpl;
import org.hibernate.jpa.AvailableSettings;
import org.hibernate.jpa.HibernateQuery;
import org.hibernate.jpa.TypedParameterValue;
import org.hibernate.jpa.internal.util.ConfigurationHelper;
import org.hibernate.jpa.internal.util.LockModeTypeHelper;
import org.hibernate.jpa.spi.AbstractEntityManagerImpl;
import org.hibernate.jpa.spi.AbstractQueryImpl;
import org.hibernate.jpa.spi.NullTypeBindableParameterRegistration;
import org.hibernate.jpa.spi.ParameterBind;
import org.hibernate.jpa.spi.ParameterRegistration;
import org.hibernate.type.CompositeCustomType;
import org.hibernate.type.Type;
@ -230,11 +230,17 @@ public class QueryImpl<X> extends AbstractQueryImpl<X>
}
@Override
@SuppressWarnings("unchecked")
public void bindValue(T value) {
validateBinding( getParameterType(), value, null );
if ( name != null ) {
if ( value instanceof Collection ) {
if ( value instanceof TypedParameterValue ) {
final TypedParameterValue typedValueWrapper = (TypedParameterValue ) value;
nativeQuery.setParameter( name, typedValueWrapper.getValue(), typedValueWrapper.getType() );
value = (T) typedValueWrapper.getValue();
}
else if ( value instanceof Collection ) {
nativeQuery.setParameterList( name, (Collection) value );
}
else {
@ -242,7 +248,14 @@ public class QueryImpl<X> extends AbstractQueryImpl<X>
}
}
else {
nativeQuery.setParameter( position - 1, value );
if ( value instanceof TypedParameterValue ) {
final TypedParameterValue typedValueWrapper = (TypedParameterValue ) value;
nativeQuery.setParameter( position, typedValueWrapper.getValue(), typedValueWrapper.getType() );
value = (T) typedValueWrapper.getValue();
}
else {
nativeQuery.setParameter( position - 1, value );
}
}
bind = new ParameterBindImpl<T>( value, null );

5
hibernate-entitymanager/src/main/java/org/hibernate/jpa/spi/BaseQueryImpl.java
View File

@ -29,6 +29,7 @@ import org.hibernate.QueryParameterException;
import org.hibernate.engine.query.spi.EntityGraphQueryHint;
import org.hibernate.jpa.AvailableSettings;
import org.hibernate.jpa.QueryHints;
import org.hibernate.jpa.TypedParameterValue;
import org.hibernate.jpa.graph.internal.EntityGraphImpl;
import org.hibernate.jpa.internal.EntityManagerMessageLogger;
import org.hibernate.jpa.internal.util.CacheModeHelper;
@ -876,6 +877,10 @@ public abstract class BaseQueryImpl implements Query {
return;
}
if ( bind instanceof TypedParameterValue ) {
bind = ( (TypedParameterValue ) bind ).getValue();
}
if ( Collection.class.isInstance( bind ) && ! Collection.class.isAssignableFrom( parameterType ) ) {
// we have a collection passed in where we are expecting a non-collection.
// NOTE : this can happen in Hibernate's notion of "parameter list" binding

230
hibernate-entitymanager/src/test/java/org/hibernate/jpa/test/query/TypedValueParametersTest.java Normal file
View File

@ -0,0 +1,230 @@
/*
* 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.jpa.test.query;
import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityManager;
import javax.persistence.Id;
import javax.persistence.Persistence;
import javax.persistence.Query;
import javax.persistence.Table;
import javax.persistence.TypedQuery;
import org.hibernate.HibernateException;
import org.hibernate.annotations.Type;
import org.hibernate.annotations.TypeDef;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.engine.spi.TypedValue;
import org.hibernate.jpa.TypedParameterValue;
import org.hibernate.jpa.test.BaseEntityManagerFunctionalTestCase;
import org.hibernate.type.CustomType;
import org.hibernate.usertype.UserType;
import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
/**
* @author Steve Ebersole
*/
public class TypedValueParametersTest extends BaseEntityManagerFunctionalTestCase {
@Override
protected Class<?>[] getAnnotatedClasses() {
return new Class[] { Document.class };
}
private int docId;
@Before
public void init() throws Exception {
EntityManager em = getOrCreateEntityManager();
em.getTransaction().begin();
Document a = new Document();
a.getTags().add("important");
a.getTags().add("business");
em.persist(a);
docId = a.getId();
em.getTransaction().commit();
em.close();
}
@Test
public void testNative() {
test(new Binder() {
public void bind(Query q) {
org.hibernate.Query hibernateQuery = q.unwrap(org.hibernate.Query.class);
hibernateQuery.setParameter("tags", Arrays.asList("important","business"), new CustomType(TagUserType.INSTANCE));
}
});
}
@Test
public void testJpa() {
test(new Binder() {
public void bind(Query q) {
q.setParameter("tags", new TypedParameterValue( new CustomType( TagUserType.INSTANCE), Arrays.asList("important","business")));
}
});
}
private void test(Binder b) {
EntityManager em = getOrCreateEntityManager();
em.getTransaction().begin();
TypedQuery<Long> q = em.createQuery( "select count(*) from Document d where d.tags = :tags", Long.class );
b.bind( q );
Long count = q.getSingleResult();
em.getTransaction().commit();
em.close();
assertEquals( 1, count.intValue() );
}
private interface Binder {
void bind(Query q);
}
@Entity( name = "Document" )
@Table( name = "Document" )
@TypeDef(name = "tagList", typeClass = TagUserType.class)
public static class Document {
@Id
private int id;
@Type(type = "tagList")
@Column(name = "tags")
private List<String> tags = new ArrayList<String>();
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public List<String> getTags() {
return tags;
}
public void setTags(List<String> tags) {
this.tags = tags;
}
}
public static class TagUserType implements UserType {
public static final UserType INSTANCE = new TagUserType();
private final int SQLTYPE = java.sql.Types.VARCHAR;
@Override
public void nullSafeSet(PreparedStatement statement, Object value, int index, SessionImplementor session) throws HibernateException, SQLException {
if (value == null) {
statement.setNull(index, SQLTYPE);
} else {
@SuppressWarnings("unchecked")
List<String> list = (List<String>) value;
StringBuilder sb = new StringBuilder();
for (int i = 0; i < list.size(); i++) {
if (i != 0) {
sb.append('|');
}
sb.append(list.get(i));
}
statement.setString(index, sb.toString());
}
}
@Override
public Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException {
String string = rs.getString(names[0]);
if (rs.wasNull()) {
return null;
}
List<String> list = new ArrayList<String>();
int lastIndex = 0, index;
while ((index = string.indexOf('|', lastIndex)) != -1) {
list.add(string.substring(lastIndex, index));
lastIndex = index + 1;
}
if (lastIndex != string.length()) {
list.add(string.substring(lastIndex));
}
return list;
}
public int[] sqlTypes() {
return new int[]{SQLTYPE};
}
public Class returnedClass() {
return List.class;
}
@Override
public Object assemble(final Serializable cached, final Object owner) throws HibernateException {
return cached;
}
@Override
@SuppressWarnings("unchecked")
public Object deepCopy(final Object o) throws HibernateException {
return o == null ? null : new ArrayList<String>((List<String>) o);
}
@Override
public Serializable disassemble(final Object o) throws HibernateException {
return (Serializable) o;
}
@Override
public boolean equals(final Object x, final Object y) throws HibernateException {
return x == null ? y == null : x.equals(y);
}
@Override
public int hashCode(final Object o) throws HibernateException {
return o == null ? 0 : o.hashCode();
}
@Override
public boolean isMutable() {
return true;
}
@Override
public Object replace(final Object original, final Object target, final Object owner) throws HibernateException {
return original;
}
}
}