Package org.hibernate.ejb.criteria

Source Code of org.hibernate.ejb.criteria.CriteriaBuilderImpl

/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2009 by Red Hat Inc and/or its affiliates or by
* third-party contributors as indicated by either @author tags or express
* copyright attribution statements applied by the authors.  All
* third-party contributions are distributed under license by Red Hat Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA  02110-1301  USA
*/
package org.hibernate.ejb.criteria;
import java.io.Serializable;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.persistence.Tuple;
import javax.persistence.criteria.CompoundSelection;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Expression;
import javax.persistence.criteria.Order;
import javax.persistence.criteria.ParameterExpression;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Selection;
import javax.persistence.criteria.Subquery;
import org.hibernate.ejb.EntityManagerFactoryImpl;
import org.hibernate.ejb.criteria.expression.BinaryArithmeticOperation;
import org.hibernate.ejb.criteria.expression.CoalesceExpression;
import org.hibernate.ejb.criteria.expression.CompoundSelectionImpl;
import org.hibernate.ejb.criteria.expression.ConcatExpression;
import org.hibernate.ejb.criteria.expression.LiteralExpression;
import org.hibernate.ejb.criteria.expression.NullLiteralExpression;
import org.hibernate.ejb.criteria.expression.NullifExpression;
import org.hibernate.ejb.criteria.expression.ParameterExpressionImpl;
import org.hibernate.ejb.criteria.expression.SearchedCaseExpression;
import org.hibernate.ejb.criteria.expression.SimpleCaseExpression;
import org.hibernate.ejb.criteria.expression.SizeOfCollectionExpression;
import org.hibernate.ejb.criteria.expression.SubqueryComparisonModifierExpression;
import org.hibernate.ejb.criteria.expression.UnaryArithmeticOperation;
import org.hibernate.ejb.criteria.expression.function.AbsFunction;
import org.hibernate.ejb.criteria.expression.function.AggregationFunction;
import org.hibernate.ejb.criteria.expression.function.BasicFunctionExpression;
import org.hibernate.ejb.criteria.expression.function.CurrentDateFunction;
import org.hibernate.ejb.criteria.expression.function.CurrentTimeFunction;
import org.hibernate.ejb.criteria.expression.function.CurrentTimestampFunction;
import org.hibernate.ejb.criteria.expression.function.LengthFunction;
import org.hibernate.ejb.criteria.expression.function.LocateFunction;
import org.hibernate.ejb.criteria.expression.function.LowerFunction;
import org.hibernate.ejb.criteria.expression.function.ParameterizedFunctionExpression;
import org.hibernate.ejb.criteria.expression.function.SqrtFunction;
import org.hibernate.ejb.criteria.expression.function.SubstringFunction;
import org.hibernate.ejb.criteria.expression.function.TrimFunction;
import org.hibernate.ejb.criteria.expression.function.UpperFunction;
import org.hibernate.ejb.criteria.path.PluralAttributePath;
import org.hibernate.ejb.criteria.predicate.BetweenPredicate;
import org.hibernate.ejb.criteria.predicate.BooleanAssertionPredicate;
import org.hibernate.ejb.criteria.predicate.BooleanExpressionPredicate;
import org.hibernate.ejb.criteria.predicate.BooleanStaticAssertionPredicate;
import org.hibernate.ejb.criteria.predicate.ComparisonPredicate;
import org.hibernate.ejb.criteria.predicate.ComparisonPredicate.ComparisonOperator;
import org.hibernate.ejb.criteria.predicate.CompoundPredicate;
import org.hibernate.ejb.criteria.predicate.ExistsPredicate;
import org.hibernate.ejb.criteria.predicate.InPredicate;
import org.hibernate.ejb.criteria.predicate.IsEmptyPredicate;
import org.hibernate.ejb.criteria.predicate.LikePredicate;
import org.hibernate.ejb.criteria.predicate.MemberOfPredicate;
import org.hibernate.ejb.criteria.predicate.NullnessPredicate;

/**
* Hibernate implementation of the JPA {@link CriteriaBuilder} contract.
*
* @author Steve Ebersole
*/
public class CriteriaBuilderImpl implements CriteriaBuilder, Serializable {
  private final EntityManagerFactoryImpl entityManagerFactory;

  public CriteriaBuilderImpl(EntityManagerFactoryImpl entityManagerFactory) {
    this.entityManagerFactory = entityManagerFactory;
  }

  /**
   * Provides protected access to the underlying {@link EntityManagerFactoryImpl}.
   *
   * @return The underlying {@link EntityManagerFactoryImpl}
   */
  public  EntityManagerFactoryImpl getEntityManagerFactory() {
    return entityManagerFactory;
  }

  /**
   * {@inheritDoc}
   */
  public CriteriaQuery<Object> createQuery() {
    return new CriteriaQueryImpl<Object>( this, Object.class );
  }

  /**
   * {@inheritDoc}
   */
  public <T> CriteriaQuery<T> createQuery(Class<T> resultClass) {
    return new CriteriaQueryImpl<T>( this, resultClass );
  }

  /**
   * {@inheritDoc}
   */
  public CriteriaQuery<Tuple> createTupleQuery() {
    return new CriteriaQueryImpl<Tuple>( this, Tuple.class );
  }

  /**
   * Package-protected method to centralize checking of criteria query
   * multiselects as defined by the
   * {@link CriteriaQuery#multiselect(List)}  method.
   *
   * @param selections The selection varargs to check
   *
   * @throws IllegalArgumentException If, as per
   * {@link CriteriaQuery#multiselect(List)} documentation,
   * <i>&quot;An argument to the multiselect method must not be a tuple-
     * or array-valued compound selection item.&quot;</i>
   */
  void checkMultiselect(List<Selection<?>> selections) {
    for ( Selection<?> selection : selections ) {
      if ( selection.isCompoundSelection() ) {
        if ( selection.getJavaType().isArray() ) {
          throw new IllegalArgumentException(
              "multiselect selections cannot contain " +
                  "compound array-valued elements"
          );
        }
        if ( Tuple.class.isAssignableFrom( selection.getJavaType() ) ) {
          throw new IllegalArgumentException(
              "multiselect selections cannot contain " +
                  "compound tuple-valued elements"
          );
        }
      }
    }
  }

  /**
   * {@inheritDoc}
   */
  public CompoundSelection<Tuple> tuple(Selection<?>... selections) {
    return tuple( Arrays.asList( selections ) );
  }

  /**
   * Version of {@link #tuple(Selection[])} taking a list.
   *
   * @param selections List of selections.
   *
   * @return The tuple compound selection
   */
  public CompoundSelection<Tuple> tuple(List<Selection<?>> selections) {
    checkMultiselect( selections );
    return new CompoundSelectionImpl<Tuple>( this, Tuple.class, selections );
  }

  /**
   * {@inheritDoc}
   */
  public CompoundSelection<Object[]> array(Selection<?>... selections) {
    return array( Arrays.asList( selections ) );
  }

  /**
   * Version of {@link #array(Selection[])} taking a list of selections.
   *
   * @param selections List of selections.
   *
   * @return The array compound selection
   */
  public CompoundSelection<Object[]> array(List<Selection<?>> selections) {
    return array( Object[].class, selections );
  }

  /**
   * Version of {@link #array(Selection[])} taking a list of selections,
   * as well as the type of array.
   *
   * @param type The type of array
   * @param selections List of selections.
   *
   * @return The array compound selection
   */
  public <Y> CompoundSelection<Y> array(Class<Y> type, List<Selection<?>> selections) {
    checkMultiselect( selections );
    return new CompoundSelectionImpl<Y>( this, type, selections );
  }

  /**
   * {@inheritDoc}
   */
  public <Y> CompoundSelection<Y> construct(Class<Y> result, Selection<?>... selections) {
    return construct( result, Arrays.asList( selections ) );
  }

  /**
   * Version of {@link #construct(Class,Selection[])} taking the
   * to-be-constructed type as well as a list of selections.
   *
   * @param result The result class to be constructed.
   * @param selections The selections to use in the constructor call.
   *
   * @return The <b>view</b> compound selection.
   */
  public <Y> CompoundSelection<Y> construct(Class<Y> result, List<Selection<?>> selections) {
    checkMultiselect( selections );
    return new CompoundSelectionImpl<Y>( this, result, selections );
  }


  // ordering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public Order asc(Expression<?> x) {
    return new OrderImpl( x, true );
  }

  /**
   * {@inheritDoc}
   */
  public Order desc(Expression<?> x) {
    return new OrderImpl( x, false );
  }


  // predicates ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  public Predicate wrap(Expression<Boolean> expression) {
    if ( Predicate.class.isInstance( expression ) ) {
      return ( (Predicate) expression );
    }
    else if ( PathImplementor.class.isInstance( expression ) ) {
      return new BooleanAssertionPredicate( this, expression, Boolean.TRUE );
    }
    else {
      return new BooleanExpressionPredicate( this, expression );
    }
  }

  /**
   * {@inheritDoc}
   */
  public Predicate not(Expression<Boolean> expression) {
    return wrap( expression ).not();
  }

  /**
   * {@inheritDoc}
   */
  public Predicate and(Expression<Boolean> x, Expression<Boolean> y) {
    return new CompoundPredicate( this, Predicate.BooleanOperator.AND, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate or(Expression<Boolean> x, Expression<Boolean> y) {
    return new CompoundPredicate( this, Predicate.BooleanOperator.OR, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate and(Predicate... restrictions) {
    return new CompoundPredicate( this, Predicate.BooleanOperator.AND, restrictions );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate or(Predicate... restrictions) {
    return new CompoundPredicate( this, Predicate.BooleanOperator.OR, restrictions );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate conjunction() {
    return new CompoundPredicate( this, Predicate.BooleanOperator.AND );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate disjunction() {
    return new CompoundPredicate( this, Predicate.BooleanOperator.OR );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate isTrue(Expression<Boolean> expression) {
    if ( CompoundPredicate.class.isInstance( expression ) ) {
      final CompoundPredicate predicate = (CompoundPredicate) expression;
      if ( predicate.getExpressions().size() == 0 ) {
        return new BooleanStaticAssertionPredicate(
            this,
            predicate.getOperator() == Predicate.BooleanOperator.AND
        );
      }
      return predicate;
    }
    else if ( Predicate.class.isInstance( expression ) ) {
      return (Predicate) expression;
    }
    return new BooleanAssertionPredicate( this, expression, Boolean.TRUE );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate isFalse(Expression<Boolean> expression) {
    if ( CompoundPredicate.class.isInstance( expression ) ) {
      final CompoundPredicate predicate = (CompoundPredicate) expression;
      if ( predicate.getExpressions().size() == 0 ) {
        return new BooleanStaticAssertionPredicate(
            this,
            predicate.getOperator() == Predicate.BooleanOperator.OR
        );
      }
      predicate.not();
      return predicate;
    }
    else if ( Predicate.class.isInstance( expression ) ) {
      final Predicate predicate = (Predicate) expression;
      predicate.not();
      return predicate;
    }
    return new BooleanAssertionPredicate( this, expression, Boolean.FALSE );
  }

  /**s
   * {@inheritDoc}
   */
  public Predicate isNull(Expression<?> x) {
    return new NullnessPredicate( this, x );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate isNotNull(Expression<?> x) {
    return isNull( x ).not();
  }

  /**
   * {@inheritDoc}
   */
  public Predicate equal(Expression<?> x, Expression<?> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate notEqual(Expression<?> x, Expression<?> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.NOT_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate equal(Expression<?> x, Object y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate notEqual(Expression<?> x, Object y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.NOT_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate greaterThan(Expression<? extends Y> x, Expression<? extends Y> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate lessThan(
      Expression<? extends Y> x,
      Expression<? extends Y> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate greaterThanOrEqualTo(
      Expression<? extends Y> x,
      Expression<? extends Y> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate lessThanOrEqualTo(
      Expression<? extends Y> x,
      Expression<? extends Y> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate greaterThan(
      Expression<? extends Y> x,
      Y y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate lessThan(
      Expression<? extends Y> x,
      Y y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate greaterThanOrEqualTo(
      Expression<? extends Y> x,
      Y y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public<Y extends Comparable<? super Y>> Predicate lessThanOrEqualTo(
      Expression<? extends Y> x,
      Y y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate gt(Expression<? extends Number> x, Expression<? extends Number> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate lt(Expression<? extends Number> x, Expression<? extends Number> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate ge(Expression<? extends Number> x, Expression<? extends Number> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate le(Expression<? extends Number> x, Expression<? extends Number> y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate gt(Expression<? extends Number> x, Number y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate lt(Expression<? extends Number> x, Number y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate ge(Expression<? extends Number> x, Number y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.GREATER_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public Predicate le(Expression<? extends Number> x, Number y) {
    //noinspection SuspiciousNameCombination
    return new ComparisonPredicate( this, ComparisonOperator.LESS_THAN_OR_EQUAL, x, y );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate between(
      Expression<? extends Y> expression,
      Y lowerBound,
      Y upperBound) {
    return new BetweenPredicate<Y>( this, expression, lowerBound, upperBound );
  }

  /**
   * {@inheritDoc}
   */
  public <Y extends Comparable<? super Y>> Predicate between(
      Expression<? extends Y> expression,
      Expression<? extends Y> lowerBound,
      Expression<? extends Y> upperBound) {
    return new BetweenPredicate<Y>( this, expression, lowerBound, upperBound );
  }

  /**
   * {@inheritDoc}
   */
  public <T> In<T> in(Expression<? extends T> expression) {
    return new InPredicate<T>( this, expression );
  }

  public <T> In<T> in(Expression<? extends T> expression, Expression<? extends T>... values) {
    return new InPredicate<T>( this, expression, values );
  }

  public <T> In<T> in(Expression<? extends T> expression, T... values) {
    return new InPredicate<T>( this, expression, values );
  }

  public <T> In<T> in(Expression<? extends T> expression, Collection<T> values) {
    return new InPredicate<T>( this, expression, values );
  }

  public Predicate like(Expression<String> matchExpression, Expression<String> pattern) {
    return new LikePredicate( this, matchExpression, pattern );
  }

  public Predicate like(Expression<String> matchExpression, Expression<String> pattern, Expression<Character> escapeCharacter) {
    return new LikePredicate( this, matchExpression, pattern, escapeCharacter );
  }

  public Predicate like(Expression<String> matchExpression, Expression<String> pattern, char escapeCharacter) {
    return new LikePredicate( this, matchExpression, pattern, escapeCharacter );
  }

  public Predicate like(Expression<String> matchExpression, String pattern) {
    return new LikePredicate( this, matchExpression, pattern );
  }

  public Predicate like(Expression<String> matchExpression, String pattern, Expression<Character> escapeCharacter) {
    return new LikePredicate( this, matchExpression, pattern, escapeCharacter );
  }

  public Predicate like(Expression<String> matchExpression, String pattern, char escapeCharacter) {
    return new LikePredicate( this, matchExpression, pattern, escapeCharacter );
  }

  public Predicate notLike(Expression<String> matchExpression, Expression<String> pattern) {
    return like( matchExpression, pattern ).not();
  }

  public Predicate notLike(Expression<String> matchExpression, Expression<String> pattern, Expression<Character> escapeCharacter) {
    return like( matchExpression, pattern, escapeCharacter ).not();
  }

  public Predicate notLike(Expression<String> matchExpression, Expression<String> pattern, char escapeCharacter) {
    return like( matchExpression, pattern, escapeCharacter ).not();
  }

  public Predicate notLike(Expression<String> matchExpression, String pattern) {
    return like( matchExpression, pattern ).not();
  }

  public Predicate notLike(Expression<String> matchExpression, String pattern, Expression<Character> escapeCharacter) {
    return like( matchExpression, pattern, escapeCharacter ).not();
  }

  public Predicate notLike(Expression<String> matchExpression, String pattern, char escapeCharacter) {
    return like( matchExpression, pattern, escapeCharacter ).not();
  }


  // parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public <T> ParameterExpression<T> parameter(Class<T> paramClass) {
    return new ParameterExpressionImpl<T>( this, paramClass );
  }

  /**
   * {@inheritDoc}
   */
  public <T> ParameterExpression<T> parameter(Class<T> paramClass, String name) {
    return new ParameterExpressionImpl<T>( this, paramClass, name );
  }

  /**
   * {@inheritDoc}
   */
  public <T> Expression<T> literal(T value) {
    if ( value == null ) {
      throw new IllegalArgumentException( "literal value cannot be null" );
    }
    return new LiteralExpression<T>( this, value );
  }

  /**
   * {@inheritDoc}
   */
  public <T> Expression<T> nullLiteral(Class<T> resultClass) {
    return new NullLiteralExpression<T>( this, resultClass );
  }


  // aggregate functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public <N extends Number> Expression<Double> avg(Expression<N> x) {
    return new AggregationFunction.AVG( this, x );
  }

  /**
   * {@inheritDoc}
   */
  public <N extends Number> Expression<N> sum(Expression<N> x) {
    return new AggregationFunction.SUM<N>( this, x );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Long> sumAsLong(Expression<Integer> x) {
    return new AggregationFunction.SUM<Long>( this, x, Long.class );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Double> sumAsDouble(Expression<Float> x) {
    return new AggregationFunction.SUM<Double>( this, x, Double.class );
  }

  /**
   * {@inheritDoc}
   */
  public <N extends Number> Expression<N> max(Expression<N> x) {
    return new AggregationFunction.MAX<N>( this, x );
  }

  /**
   * {@inheritDoc}
   */
  public <N extends Number> Expression<N> min(Expression<N> x) {
    return new AggregationFunction.MIN<N>( this, x );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <X extends Comparable<? super X>> Expression<X> greatest(Expression<X> x) {
    return new AggregationFunction.GREATEST( this, x );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <X extends Comparable<? super X>> Expression<X> least(Expression<X> x) {
    return new AggregationFunction.LEAST( this, x );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Long> count(Expression<?> x) {
    return new AggregationFunction.COUNT( this, x, false );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Long> countDistinct(Expression<?> x) {
    return new AggregationFunction.COUNT( this, x, true );
  }


  // other functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public <T> Expression<T> function(String name, Class<T> returnType, Expression<?>... arguments) {
    return new ParameterizedFunctionExpression<T>( this, returnType, name, arguments );
  }

  /**
   * Create a reference to a function taking no params.
   *
   * @param name The function name.
   * @param returnType The return type.
   *
   * @return The function expression
   */
  public <T> Expression<T> function(String name, Class<T> returnType) {
    return new BasicFunctionExpression<T>( this, returnType, name );
  }

  /**
   * {@inheritDoc}
   */
  public <N extends Number> Expression<N> abs(Expression<N> expression) {
    return new AbsFunction<N>( this, expression );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Double> sqrt(Expression<? extends Number> expression) {
    return new SqrtFunction( this, expression );
  }

  public Expression<java.sql.Date> currentDate() {
    return new CurrentDateFunction( this );
  }

  public Expression<java.sql.Timestamp> currentTimestamp() {
    return new CurrentTimestampFunction( this );
  }

  public Expression<java.sql.Time> currentTime() {
    return new CurrentTimeFunction( this );
  }

  public Expression<String> substring(Expression<String> value, Expression<Integer> start) {
    return new SubstringFunction( this, value, start );
  }

  public Expression<String> substring(Expression<String> value, int start) {
    return new SubstringFunction( this, value, start );
  }

  public Expression<String> substring(Expression<String> value, Expression<Integer> start, Expression<Integer> length) {
    return new SubstringFunction( this, value, start, length );
  }

  public Expression<String> substring(Expression<String> value, int start, int length) {
    return new SubstringFunction( this, value, start, length );
  }

  public Expression<String> trim(Expression<String> trimSource ) {
    return new TrimFunction( this, trimSource );
  }

  public Expression<String> trim(Trimspec trimspec, Expression<String> trimSource) {
    return new TrimFunction( this, trimspec, trimSource );
  }

  public Expression<String> trim(Expression<Character> trimCharacter, Expression<String> trimSource) {
    return new TrimFunction( this, trimCharacter, trimSource );
  }

  public Expression<String> trim(Trimspec trimspec, Expression<Character> trimCharacter, Expression<String> trimSource) {
    return new TrimFunction( this, trimspec, trimCharacter, trimSource );
  }

  public Expression<String> trim(char trimCharacter, Expression<String> trimSource) {
    return new TrimFunction( this, trimCharacter, trimSource );
  }

  public Expression<String> trim(Trimspec trimspec, char trimCharacter, Expression<String> trimSource) {
    return new TrimFunction( this, trimspec, trimCharacter, trimSource );
  }

  public Expression<String> lower(Expression<String> value) {
    return new LowerFunction( this, value );
  }

  public Expression<String> upper(Expression<String> value) {
    return new UpperFunction( this, value );
  }

  public Expression<Integer> length(Expression<String> value) {
    return new LengthFunction( this, value );
  }

  public Expression<Integer> locate(Expression<String> string, Expression<String> pattern) {
    return new LocateFunction( this, pattern, string );
  }

  public Expression<Integer> locate(Expression<String> string, Expression<String> pattern, Expression<Integer> start) {
    return new LocateFunction( this, pattern, string, start );
  }

  public Expression<Integer> locate(Expression<String> string, String pattern) {
    return new LocateFunction( this, pattern, string );
  }

  public Expression<Integer> locate(Expression<String> string, String pattern, int start) {
    return new LocateFunction( this, pattern, string, start );
  }


  // arithmetic operations ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public <N extends Number> Expression<N> neg(Expression<N> expression) {
    return new UnaryArithmeticOperation<N>(
        this,
        UnaryArithmeticOperation.Operation.UNARY_MINUS,
        expression
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> sum(Expression<? extends N> expression1, Expression<? extends N> expression2) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression1 );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, (Expression)expression2 );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.ADD,
        expression1,
        expression2
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> prod(Expression<? extends N> expression1, Expression<? extends N> expression2) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression1 );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, (Expression)expression2 );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.MULTIPLY,
        expression1,
        expression2
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> diff(Expression<? extends N> expression1, Expression<? extends N> expression2) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression1 );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, (Expression)expression2 );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.SUBTRACT,
        expression1,
        expression2
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> sum(Expression<? extends N> expression, N n) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, n );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.ADD,
        expression,
        n
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> prod(Expression<? extends N> expression, N n) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, n );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.MULTIPLY,
        expression,
        n
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> diff(Expression<? extends N> expression, N n) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, n );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.SUBTRACT,
        expression,
        n
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> sum(N n, Expression<? extends N> expression) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, n );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.ADD,
        n,
        expression
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> prod(N n, Expression<? extends N> expression) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, n );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.MULTIPLY,
        n,
        expression
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <N extends Number> Expression<N> diff(N n, Expression<? extends N> expression) {
    Class<N> type = (Class<N>)BinaryArithmeticOperation.determineReturnType( (Class)Number.class, (Expression)expression );
    type = (Class<N>)BinaryArithmeticOperation.determineReturnType( type, n );
    return new BinaryArithmeticOperation<N>(
        this,
        type,
        BinaryArithmeticOperation.Operation.SUBTRACT,
        n,
        expression
    );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Number> quot(Expression<? extends Number> expression1, Expression<? extends Number> expression2) {
    return new BinaryArithmeticOperation<Number>(
        this,
        Number.class,
        BinaryArithmeticOperation.Operation.DIVIDE,
        expression1,
        expression2
    );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Number> quot(Expression<? extends Number> expression, Number number) {
    return new BinaryArithmeticOperation<Number>(
        this,
        Number.class,
        BinaryArithmeticOperation.Operation.DIVIDE,
        expression,
        number
    );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Number> quot(Number number, Expression<? extends Number> expression) {
    return new BinaryArithmeticOperation<Number>(
        this,
        Number.class,
        BinaryArithmeticOperation.Operation.DIVIDE,
        number,
        expression
    );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Integer> mod(Expression<Integer> expression1, Expression<Integer> expression2) {
    return new BinaryArithmeticOperation<Integer>(
        this,
        Integer.class,
        BinaryArithmeticOperation.Operation.MOD,
        expression1,
        expression2
    );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Integer> mod(Expression<Integer> expression, Integer integer) {
    return new BinaryArithmeticOperation<Integer>(
        this,
        Integer.class,
        BinaryArithmeticOperation.Operation.MOD,
        expression,
        integer
    );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<Integer> mod(Integer integer, Expression<Integer> expression) {
    return new BinaryArithmeticOperation<Integer>(
        this,
        Integer.class,
        BinaryArithmeticOperation.Operation.MOD,
        integer,
        expression
    );
  }


  // casting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<Long> toLong(Expression<? extends Number> expression) {
    return ( (ExpressionImplementor<? extends Number>) expression ).asLong();
  }

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<Integer> toInteger(Expression<? extends Number> expression) {
    return ( (ExpressionImplementor<? extends Number>) expression ).asInteger();
  }

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<Float> toFloat(Expression<? extends Number> expression) {
    return ( (ExpressionImplementor<? extends Number>) expression ).asFloat();
  }

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<Double> toDouble(Expression<? extends Number> expression) {
    return ( (ExpressionImplementor<? extends Number>) expression ).asDouble();
  }

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<BigDecimal> toBigDecimal(Expression<? extends Number> expression) {
    return ( (ExpressionImplementor<? extends Number>) expression ).asBigDecimal();
  }

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<BigInteger> toBigInteger(Expression<? extends Number> expression) {
    return ( (ExpressionImplementor<? extends Number>) expression ).asBigInteger();
  }

  /**
   * {@inheritDoc}
   */
  public ExpressionImplementor<String> toString(Expression<Character> characterExpression) {
    return ( (ExpressionImplementor<Character>) characterExpression ).asString();
  }


  // subqueries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  public Predicate exists(Subquery<?> subquery) {
    return new ExistsPredicate( this, subquery );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <Y> Expression<Y> all(Subquery<Y> subquery) {
    return new SubqueryComparisonModifierExpression<Y>(
        this,
        (Class<Y>) subquery.getJavaType(),
        subquery,
        SubqueryComparisonModifierExpression.Modifier.ALL
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <Y> Expression<Y> some(Subquery<Y> subquery) {
    return new SubqueryComparisonModifierExpression<Y>(
        this,
        (Class<Y>) subquery.getJavaType(),
        subquery,
        SubqueryComparisonModifierExpression.Modifier.SOME
    );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <Y> Expression<Y> any(Subquery<Y> subquery) {
    return new SubqueryComparisonModifierExpression<Y>(
        this,
        (Class<Y>) subquery.getJavaType(),
        subquery,
        SubqueryComparisonModifierExpression.Modifier.ANY
    );
  }


  // miscellaneous expressions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "RedundantCast" })
  public <Y> Expression<Y> coalesce(Expression<? extends Y> exp1, Expression<? extends Y> exp2) {
    return coalesce( (Class<Y>) null, exp1, exp2 );
  }

  public <Y> Expression<Y> coalesce(Class<Y> type, Expression<? extends Y> exp1, Expression<? extends Y> exp2) {
    return new CoalesceExpression<Y>( this, type ).value( exp1 ).value( exp2 );
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "RedundantCast" })
  public <Y> Expression<Y> coalesce(Expression<? extends Y> exp1, Y exp2) {
    return coalesce( (Class<Y>) null, exp1, exp2 );
  }

  public <Y> Expression<Y> coalesce(Class<Y> type, Expression<? extends Y> exp1, Y exp2) {
    return new CoalesceExpression<Y>( this, type ).value( exp1 ).value( exp2 );
  }

  /**
   * {@inheritDoc}
   */
  public <T> Coalesce<T> coalesce() {
    return coalesce( (Class<T>)null );
  }

  public <T> Coalesce<T> coalesce(Class<T> type) {
    return new CoalesceExpression<T>( this, type );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<String> concat(Expression<String> string1, Expression<String> string2) {
    return new ConcatExpression( this, string1, string2 );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<String> concat(Expression<String> string1, String string2) {
    return new ConcatExpression( this, string1, string2 );
  }

  /**
   * {@inheritDoc}
   */
  public Expression<String> concat(String string1, Expression<String> string2) {
    return new ConcatExpression( this, string1, string2 );
  }

  /**
   * {@inheritDoc}
   */
  public <Y> Expression<Y> nullif(Expression<Y> exp1, Expression<?> exp2) {
    return nullif( null, exp1, exp2 );
  }

  public <Y> Expression<Y> nullif(Class<Y> type, Expression<Y> exp1, Expression<?> exp2) {
    return new NullifExpression<Y>( this, type, exp1, exp2 );
  }

  /**
   * {@inheritDoc}
   */
  public <Y> Expression<Y> nullif(Expression<Y> exp1, Y exp2) {
    return nullif( null, exp1, exp2 );
  }

  public <Y> Expression<Y> nullif(Class<Y> type, Expression<Y> exp1, Y exp2) {
    return new NullifExpression<Y>( this, type, exp1, exp2 );
  }

  /**
   * {@inheritDoc}
   */
  public <C, R> SimpleCase<C, R> selectCase(Expression<? extends C> expression) {
    return selectCase( (Class<R>)null, expression );
  }

  public <C, R> SimpleCase<C, R> selectCase(Class<R> type, Expression<? extends C> expression) {
    return new SimpleCaseExpression<C, R>( this, type, expression );
  }

  /**
   * {@inheritDoc}
   */
  public <R> Case<R> selectCase() {
    return selectCase( (Class<R>)null );
  }

  public <R> Case<R> selectCase(Class<R> type) {
    return new SearchedCaseExpression<R>( this, type );
  }

  /**
   * {@inheritDoc}
   */
  public <C extends Collection<?>> Expression<Integer> size(C c) {
    int size = c == null ? 0 : c.size();
    return new LiteralExpression<Integer>(this, Integer.class, size);
  }

  /**
   * {@inheritDoc}
   */
  public <C extends Collection<?>> Expression<Integer> size(Expression<C> exp) {
    if ( LiteralExpression.class.isInstance(exp) ) {
      return size( ( (LiteralExpression<C>) exp ).getLiteral() );
    }
    else if ( PluralAttributePath.class.isInstance(exp) ) {
      return new SizeOfCollectionExpression<C>(this, (PluralAttributePath<C>) exp );
    }
    // TODO : what other specific types?  any?
    throw new IllegalArgumentException("unknown collection expression type [" + exp.getClass().getName() + "]" );
  }

  /**
   * {@inheritDoc}
   */
  public <V, M extends Map<?, V>> Expression<Collection<V>> values(M map) {
    return new LiteralExpression<Collection<V>>( this, map.values() );
  }

  /**
   * {@inheritDoc}
   */
  public <K, M extends Map<K, ?>> Expression<Set<K>> keys(M map) {
    return new LiteralExpression<Set<K>>( this, map.keySet() );
  }


  /**
   * {@inheritDoc}
   */
  @SuppressWarnings({ "unchecked" })
  public <C extends Collection<?>> Predicate isEmpty(Expression<C> collectionExpression) {
    if ( PluralAttributePath.class.isInstance(collectionExpression) ) {
      return new IsEmptyPredicate( this, (PluralAttributePath<C>) collectionExpression );
    }
    // TODO : what other specific types?  any?
    throw new IllegalArgumentException(
        "unknown collection expression type [" + collectionExpression.getClass().getName() + "]"
    );
  }

  /**
   * {@inheritDoc}
   */
  public <C extends Collection<?>> Predicate isNotEmpty(Expression<C> collectionExpression) {
    return isEmpty( collectionExpression ).not();
  }

  /**
   * {@inheritDoc}
   */
  public <E, C extends Collection<E>> Predicate isMember(E e, Expression<C> collectionExpression) {
    if ( ! PluralAttributePath.class.isInstance( collectionExpression ) ) {
      throw new IllegalArgumentException(
          "unknown collection expression type [" + collectionExpression.getClass().getName() + "]"
      );
    }
    return new MemberOfPredicate<E, C>(
        this,
        e,
        (PluralAttributePath<C>)collectionExpression
    );
  }

  /**
   * {@inheritDoc}
   */
  public <E, C extends Collection<E>> Predicate isNotMember(E e, Expression<C> cExpression) {
    return isMember(e, cExpression).not();
  }

  /**
   * {@inheritDoc}
   */
  public <E, C extends Collection<E>> Predicate isMember(Expression<E> elementExpression, Expression<C> collectionExpression) {
    if ( ! PluralAttributePath.class.isInstance( collectionExpression ) ) {
      throw new IllegalArgumentException(
          "unknown collection expression type [" + collectionExpression.getClass().getName() + "]"
      );
    }
    return new MemberOfPredicate<E, C>(
        this,
        elementExpression,
        (PluralAttributePath<C>)collectionExpression
    );
  }

  /**
   * {@inheritDoc}
   */
  public <E, C extends Collection<E>> Predicate isNotMember(Expression<E> eExpression, Expression<C> cExpression) {
    return isMember(eExpression, cExpression).not();
  }
}
TOP

Related Classes of org.hibernate.ejb.criteria.CriteriaBuilderImpl

TOP
Copyright © 2018 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.