org.opencastproject.util.persistence.Queries Maven / Gradle / Ivy
/**
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License
* at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*
*/
package org.opencastproject.util.persistence;
import static org.opencastproject.util.data.Option.option;
import org.opencastproject.util.data.Function;
import org.opencastproject.util.data.Option;
import org.opencastproject.util.data.Tuple;
import org.joda.time.base.AbstractInstant;
import java.util.Date;
import java.util.List;
import javax.persistence.EntityManager;
import javax.persistence.Query;
import javax.persistence.TemporalType;
import javax.persistence.TypedQuery;
/** JPA query constructors. */
// CHECKSTYLE:OFF
public final class Queries {
private Queries() {
}
/** {@link javax.persistence.EntityManager#find(Class, Object)} as a function wrapping the result into an Option. */
public static Function> find(final Class clazz, final Object primaryKey) {
return new Function>() {
@Override public Option apply(EntityManager em) {
return option(em.find(clazz, primaryKey));
}
};
}
/** {@link javax.persistence.EntityManager#persist(Object)} as a function. */
public static Function persist(final A a) {
return new Function() {
@Override public A apply(EntityManager em) {
em.persist(a);
return a;
}
};
}
public static A persistOrUpdate(final EntityManager em, final A a) {
final Object id = em.getEntityManagerFactory().getPersistenceUnitUtil().getIdentifier(a);
if (id == null) {
em.persist(a);
return a;
} else {
@SuppressWarnings("unchecked")
final A dto = (A) em.find(a.getClass(), id);
if (dto == null) {
em.persist(a);
return a;
} else {
return em.merge(a);
}
}
}
public static Function persistOrUpdate(final A a) {
return new Function() {
@Override public A apply(EntityManager em) {
return persistOrUpdate(em, a);
}
};
}
/**
* Set a list of named parameters on a query.
*
* Values of type {@link java.util.Date} and {@link org.joda.time.base.AbstractInstant}
* are recognized and set as a timestamp ({@link javax.persistence.TemporalType#TIMESTAMP}.
*/
public static A setParams(A q, Tuple... params) {
for (Tuple p : params) {
final Object value = p.getB();
if (value instanceof Date) {
q.setParameter(p.getA(), (Date) value, TemporalType.TIMESTAMP);
}
if (value instanceof AbstractInstant) {
q.setParameter(p.getA(), ((AbstractInstant) value).toDate(), TemporalType.TIMESTAMP);
} else {
q.setParameter(p.getA(), p.getB());
}
}
return q;
}
/**
* Set a list of positional parameters on a query.
*
* Values of type {@link java.util.Date} and {@link org.joda.time.base.AbstractInstant}
* are recognized and set as a timestamp ({@link javax.persistence.TemporalType#TIMESTAMP}.
*/
public static A setParams(A q, Object... params) {
for (int i = 0; i < params.length; i++) {
final Object value = params[i];
if (value instanceof Date) {
q.setParameter(i + 1, (Date) value, TemporalType.TIMESTAMP);
}
if (value instanceof AbstractInstant) {
q.setParameter(i + 1, ((AbstractInstant) value).toDate(), TemporalType.TIMESTAMP);
} else {
q.setParameter(i + 1, value);
}
}
return q;
}
// -------------------------------------------------------------------------------------------------------------------
/** Named queries with support for named parameters. */
public static final TypedQueriesBase> named = new TypedQueriesBase>() {
@Override public Query query(EntityManager em, String q, Tuple... params) {
return setParams(em.createNamedQuery(q), params);
}
@Override
public TypedQuery query(EntityManager em, String q, Class type, Tuple... params) {
return setParams(em.createNamedQuery(q, type), params);
}
};
// -------------------------------------------------------------------------------------------------------------------
public static abstract class TypedQueriesBase extends QueriesBase
{
protected TypedQueriesBase() {
}
/**
* Create a typed query from q with a list of parameters.
* Values of type {@link java.util.Date} are recognized
* and set as a timestamp ({@link javax.persistence.TemporalType#TIMESTAMP}.
*/
public abstract TypedQuery query(EntityManager em,
String queryName,
Class type,
Tuple... params);
/** Find multiple entities. */
public List findAll(EntityManager em,
final String q,
final Class type,
final Tuple... params) {
return query(em, q, type, params).getResultList();
}
/** {@link #findAll(EntityManager, String, Class, Tuple[])} as a function. */
public Function> findAll(final String q,
final Class type,
final Tuple... params) {
return new Function>() {
@Override public List apply(EntityManager em) {
return findAll(em, q, type, params);
}
};
}
}
// -------------------------------------------------------------------------------------------------------------------
public static abstract class QueriesBase {
protected QueriesBase() {
}
/**
* Create a query from q with a list of parameters.
* Values of type {@link java.util.Date} are recognized
* and set as a timestamp ({@link javax.persistence.TemporalType#TIMESTAMP}.
*/
public abstract Query query(EntityManager em, String q, P... params);
/** Run an update (UPDATE or DELETE) query and ensure that at least one row got affected. */
public boolean update(EntityManager em, String q, P... params) {
return query(em, q, params).executeUpdate() > 0;
}
/** {@link #update(EntityManager, String, Object[])} as a function. */
public Function update(final String q, final P... params) {
return new Function() {
@Override public Boolean apply(EntityManager em) {
return update(em, q, params);
}
};
}
/** Run a COUNT(x) query. */
public long count(final EntityManager em, final String q, final P... params) {
return (Long) query(em, q, params).getSingleResult();
}
/** {@link #count(EntityManager, String, Object[])} as a function. */
public Function count(final String q, final P... params) {
return new Function() {
@Override public Long apply(EntityManager em) {
return count(em, q, params);
}
};
}
/** Find multiple entities. */
public List findAll(EntityManager em, final String q, final P... params) {
return (List) query(em, q, params).getResultList();
}
/** {@link #findAll(EntityManager, String, Object[])} as a function. */
public Function> findAll(final String q,
final P... params) {
return new Function>() {
@Override public List apply(EntityManager em) {
return findAll(em, q, params);
}
};
}
}
}