QueryCriteria.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.apache.deltaspike.data.impl.criteria;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.persistence.EntityManager;
import javax.persistence.NoResultException;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.From;
import javax.persistence.criteria.JoinType;
import javax.persistence.criteria.Path;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Selection;
import javax.persistence.metamodel.CollectionAttribute;
import javax.persistence.metamodel.ListAttribute;
import javax.persistence.metamodel.MapAttribute;
import javax.persistence.metamodel.PluralAttribute;
import javax.persistence.metamodel.SetAttribute;
import javax.persistence.metamodel.SingularAttribute;

import org.apache.deltaspike.data.api.criteria.Criteria;
import org.apache.deltaspike.data.api.criteria.QuerySelection;
import org.apache.deltaspike.data.impl.builder.OrderDirection;
import org.apache.deltaspike.data.impl.criteria.predicate.Between;
import org.apache.deltaspike.data.impl.criteria.predicate.Eq;
import org.apache.deltaspike.data.impl.criteria.predicate.EqIgnoreCase;
import org.apache.deltaspike.data.impl.criteria.predicate.FetchBuilder;
import org.apache.deltaspike.data.impl.criteria.predicate.GreaterThan;
import org.apache.deltaspike.data.impl.criteria.predicate.GreaterThanOrEqual;
import org.apache.deltaspike.data.impl.criteria.predicate.In;
import org.apache.deltaspike.data.impl.criteria.predicate.IsEmpty;
import org.apache.deltaspike.data.impl.criteria.predicate.IsNotEmpty;
import org.apache.deltaspike.data.impl.criteria.predicate.IsNotNull;
import org.apache.deltaspike.data.impl.criteria.predicate.IsNull;
import org.apache.deltaspike.data.impl.criteria.predicate.JoinBuilder;
import org.apache.deltaspike.data.impl.criteria.predicate.LessThan;
import org.apache.deltaspike.data.impl.criteria.predicate.LessThanOrEqual;
import org.apache.deltaspike.data.impl.criteria.predicate.Like;
import org.apache.deltaspike.data.impl.criteria.predicate.NotEq;
import org.apache.deltaspike.data.impl.criteria.predicate.NotEqIgnoreCase;
import org.apache.deltaspike.data.impl.criteria.predicate.NotLike;
import org.apache.deltaspike.data.impl.criteria.predicate.OrBuilder;
import org.apache.deltaspike.data.impl.criteria.predicate.PredicateBuilder;
import org.apache.deltaspike.data.impl.criteria.processor.OrderBy;
import org.apache.deltaspike.data.impl.criteria.processor.QueryProcessor;

public class QueryCriteria<C, R> implements Criteria<C, R>
{

    private static final Logger log = Logger.getLogger(QueryCriteria.class.getName());

    private EntityManager entityManager;
    private Class<C> entityClass;
    private Class<R> resultClass;
    private JoinType joinType;
    private final boolean ignoreNull = true;
    private boolean distinct = false;

    private final OrderBy<C> orderByProcessor = new OrderBy<C>();
    private final List<PredicateBuilder<C>> builders = new LinkedList<PredicateBuilder<C>>();
    private final List<QueryProcessor<C>> processors = new LinkedList<QueryProcessor<C>>();
    private final List<QuerySelection<? super C, ?>> selections = new LinkedList<QuerySelection<? super C, ?>>();

    public QueryCriteria(Class<C> entityClass, Class<R> resultClass, EntityManager entityManager)
    {
        this(entityClass, resultClass, entityManager, null);
    }

    public QueryCriteria(Class<C> entityClass, Class<R> resultClass, EntityManager entityManager, JoinType joinType)
    {
        this.entityManager = entityManager;
        this.entityClass = entityClass;
        this.resultClass = resultClass;
        this.joinType = joinType;
    }

    // --------------------------------------------------------------------
    // Public criteria methods
    // --------------------------------------------------------------------

    @Override
    public List<R> getResultList()
    {
        return createQuery().getResultList();
    }

    @Override
    public R getSingleResult()
    {
        return createQuery().getSingleResult();
    }

    @Override
    public R getOptionalResult()
    {
        try
        {
            return getSingleResult();
        }
        catch (NoResultException e)
        {
            return null;
        }
    }

    @Override
    public R getAnyResult()
    {
        List<R> queryResult = getResultList();
        return !queryResult.isEmpty() ? queryResult.get(0) : null;
    }

    @Override
    public TypedQuery<R> createQuery()
    {
        try
        {
            CriteriaBuilder builder = entityManager.getCriteriaBuilder();
            CriteriaQuery<R> query = createCriteriaQuery(builder);
            From<C, C> root = query.from(entityClass);
            if (selections.size() == 1)
            {
                Selection<?>[] selections = prepareSelections(query, builder, root);
                query.select((Selection<? extends R>) selections[0]);
            }
            if (selections.size() > 1)
            {
                query.multiselect(prepareSelections(query, builder, root));
            }
            List<Predicate> predicates = predicates(builder, root);
            query.distinct(distinct);
            if (!predicates.isEmpty())
            {
                query.where(predicates.toArray(new Predicate[predicates.size()]));
            }
            applyProcessors(query, builder, root);
            return (TypedQuery<R>) entityManager.createQuery(query);
        }
        catch (RuntimeException e)
        {
            log.log(Level.SEVERE, "Exception while creating JPA query", e);
            throw e;
        }
    }

    @Override
    public Criteria<C, R> or(Criteria<C, R>... criteria)
    {
        return internalOr(criteria);
    }

    @Override
    @SuppressWarnings("unchecked")
    public Criteria<C, R> or(Collection<Criteria<C, R>> criteria)
    {
        return internalOr(criteria.toArray(new Criteria[criteria.size()]));
    }

    @Override
    public <P, E> Criteria<C, R> join(SingularAttribute<? super C, P> att, Criteria<P, P> criteria)
    {
        add(new JoinBuilder<C, P, E>(criteria, joinType, att));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> join(ListAttribute<? super C, P> att, Criteria<P, P> criteria)
    {
        add(new JoinBuilder<C, P, E>(criteria, joinType, att));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> join(CollectionAttribute<? super C, P> att, Criteria<P, P> criteria)
    {
        add(new JoinBuilder<C, P, E>(criteria, joinType, att));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> join(SetAttribute<? super C, P> att, Criteria<P, P> criteria)
    {
        add(new JoinBuilder<C, P, E>(criteria, joinType, att));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> join(MapAttribute<? super C, E, P> att, Criteria<P, P> criteria)
    {
        add(new JoinBuilder<C, P, E>(criteria, joinType, att));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> fetch(SingularAttribute<? super C, P> att)
    {
        add(new FetchBuilder<C, P, E>(att, null));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> fetch(SingularAttribute<? super C, P> att, JoinType joinType)
    {
        add(new FetchBuilder<C, P, E>(att, joinType));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> fetch(PluralAttribute<? super C, P, E> att)
    {
        add(new FetchBuilder<C, P, E>(att, null));
        return this;
    }

    @Override
    public <P, E> Criteria<C, R> fetch(PluralAttribute<? super C, P, E> att, JoinType joinType)
    {
        add(new FetchBuilder<C, P, E>(att, joinType));
        return this;
    }

    @Override
    public <P> Criteria<C, R> orderAsc(SingularAttribute<? super C, P> att)
    {
        addOrderBy(att, OrderDirection.ASC);
        return this;
    }

    @Override
    public <P> Criteria<C, R> orderDesc(SingularAttribute<? super C, P> att)
    {
        addOrderBy(att, OrderDirection.DESC);
        return this;
    }

    @Override
    public Criteria<C, R> distinct()
    {
        distinct = true;
        return this;
    }

    @Override
    public <N> Criteria<C, N> select(Class<N> resultClass, QuerySelection<? super C, ?>... selection)
    {
        QueryCriteria<C, N> result = new QueryCriteria<C, N>(entityClass, resultClass, entityManager, joinType);
        result.builders.addAll(this.builders);
        result.distinct = this.distinct;
        result.processors.addAll(this.processors);
        result.selections.addAll(Arrays.asList(selection));
        return result;
    }

    @Override
    public Criteria<C, Object[]> select(QuerySelection<? super C, ?>... selection)
    {
        return select(Object[].class, selection);
    }

    @Override
    public List<Predicate> predicates(CriteriaBuilder builder, Path<C> path)
    {
        List<Predicate> predicates = new LinkedList<Predicate>();
        for (PredicateBuilder<C> pbuilder : builders)
        {
            List<Predicate> p = pbuilder.build(builder, path);
            predicates.addAll(p);
        }
        return predicates;
    }

    // --------------------------------------------------------------------
    // Package criteria methods
    // --------------------------------------------------------------------

    void applyProcessors(CriteriaQuery<?> query, CriteriaBuilder builder, From<C, C> from)
    {
        orderByProcessor.process(query, builder, from);
        for (QueryProcessor<C> proc : processors)
        {
            proc.process(query, builder, from);
        }
    }

    @SuppressWarnings("unchecked")
    Criteria<C, R> internalOr(Criteria<C, R>... others)
    {
        List<Criteria<C, R>> list = new LinkedList<Criteria<C, R>>();
        list.addAll(Arrays.asList(others));
        add(new OrBuilder<C>(list.toArray(new Criteria[list.size()])));
        return this;
    }

    // --------------------------------------------------------------------
    // Private criteria methods
    // --------------------------------------------------------------------

    private void add(PredicateBuilder<C> pred)
    {
        builders.add(pred);
    }

    private <P> void add(PredicateBuilder<C> pred, P value)
    {
        if (ignoreNull && value != null)
        {
            builders.add(pred);
        }
        else if (!ignoreNull)
        {
            builders.add(pred);
        }
    }

    private <P> void addOrderBy(SingularAttribute<? super C, P> att, OrderDirection orderDirection)
    {
        orderByProcessor.add(att, orderDirection);
    }

    private Selection<?>[] prepareSelections(CriteriaQuery<?> query, CriteriaBuilder builder, From<C, C> root)
    {
        List<Selection<?>> result = new ArrayList<Selection<?>>(selections.size());
        for (QuerySelection<? super C, ?> selection : selections)
        {
            result.add(selection.toSelection(query, builder, root));
        }
        return result.toArray(new Selection<?>[] {});
    }

    private CriteriaQuery<R> createCriteriaQuery(CriteriaBuilder builder)
    {
        return builder.createQuery(resultClass);
    }

    // --------------------------------------------------------------------
    // Predicates
    // --------------------------------------------------------------------

    @Override
    public <P> Criteria<C, R> eq(SingularAttribute<? super C, P> att, P value)
    {
        add(new Eq<C, P>(att, value), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> eqIgnoreCase(SingularAttribute<? super C, String> att, String value)
    {
        add(new EqIgnoreCase<C>(att, value), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> notEq(SingularAttribute<? super C, P> att, P value)
    {
        add(new NotEq<C, P>(att, value), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> notEqIgnoreCase(SingularAttribute<? super C, String> att, String value)
    {
        add(new NotEqIgnoreCase<C>(att, value), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> like(SingularAttribute<? super C, String> att, String value)
    {
        add(new Like<C>(att, value), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> likeIgnoreCase(SingularAttribute<? super C, String> att, String value)
    {
        add(new Like<C>(att, value, true), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> notLike(SingularAttribute<? super C, String> att, String value)
    {
        add(new NotLike<C>(att, value), value);
        return this;
    }

    @Override
    public <P> Criteria<C, R> notLikeIgnoreCase(SingularAttribute<? super C, String> att, String value)
    {
        add(new NotLike<C>(att, value, true), value);
        return this;
    }

    @Override
    public <P extends Comparable<? super P>> Criteria<C, R> lt(SingularAttribute<? super C, P> att, P value)
    {
        add(new LessThan<C, P>(att, value), value);
        return this;
    }

    @Override
    public <P extends Comparable<? super P>> Criteria<C, R> ltOrEq(SingularAttribute<? super C, P> att, P value)
    {
        add(new LessThanOrEqual<C, P>(att, value), value);
        return this;
    }

    @Override
    public <P extends Comparable<? super P>> Criteria<C, R> gt(SingularAttribute<? super C, P> att, P value)
    {
        add(new GreaterThan<C, P>(att, value), value);
        return this;
    }

    @Override
    public <P extends Comparable<? super P>> Criteria<C, R> gtOrEq(SingularAttribute<? super C, P> att, P value)
    {
        add(new GreaterThanOrEqual<C, P>(att, value), value);
        return this;
    }

    @Override
    public <P extends Comparable<? super P>> Criteria<C, R> between(SingularAttribute<? super C, P> att, P lower,
            P upper)
    {
        add(new Between<C, P>(att, lower, upper));
        return this;
    }

    @Override
    public <P> Criteria<C, R> isNull(SingularAttribute<? super C, P> att)
    {
        add(new IsNull<C, P>(att));
        return this;
    }

    @Override
    public <P> Criteria<C, R> notNull(SingularAttribute<? super C, P> att)
    {
        add(new IsNotNull<C, P>(att));
        return this;
    }

    @Override
    public <P extends Collection<?>> Criteria<C, R> empty(SingularAttribute<? super C, P> att)
    {
        add(new IsEmpty<C, P>(att));
        return this;
    }

    @Override
    public <P extends Collection<?>> Criteria<C, R> notEmpty(SingularAttribute<? super C, P> att)
    {
        add(new IsNotEmpty<C, P>(att));
        return this;
    }

    @Override
    public <P> Criteria<C, R> in(SingularAttribute<? super C, P> att, P... values)
    {
        add(new In<C, P>(att, values), values);
        return this;
    }
}