com.querydsl.sql.ProjectableSQLQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of querydsl-sql Show documentation
SQL support for Querydsl
There is a newer version: 6.9
/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * Licensed 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 com.querydsl.sql;

import com.mysema.commons.lang.CloseableIterator;
import com.querydsl.core.FetchableQuery;
import com.querydsl.core.JoinFlag;
import com.querydsl.core.NonUniqueResultException;
import com.querydsl.core.Query;
import com.querydsl.core.QueryFlag;
import com.querydsl.core.QueryFlag.Position;
import com.querydsl.core.support.FetchableSubQueryBase;
import com.querydsl.core.support.QueryMixin;
import com.querydsl.core.types.*;
import com.querydsl.core.types.dsl.Expressions;
import com.querydsl.core.types.dsl.Wildcard;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.jetbrains.annotations.Nullable;

/**
 * {@code ProjectableSQLQuery} is the base type for SQL query implementations
 *
 * @param  result type
 * @param  concrete subtype
 */
public abstract class ProjectableSQLQuery & Query>
    extends FetchableSubQueryBase implements SQLCommonQuery, FetchableQuery {

  private static final Path defaultQueryAlias = ExpressionUtils.path(Object.class, "query");

  protected final Configuration configuration;

  @Nullable protected Expression union;

  protected SubQueryExpression firstUnionSubQuery;

  protected boolean unionAll;

  @SuppressWarnings("unchecked")
  public ProjectableSQLQuery(QueryMixin queryMixin, Configuration configuration) {
    super(queryMixin);
    this.queryMixin.setSelf((Q) this);
    this.configuration = configuration;
  }

  @Override
  public  R accept(Visitor v, @Nullable C context) {
    if (union != null) {
      return union.accept(v, context);
    } else {
      return super.accept(v, context);
    }
  }

  /**
   * Add the given String literal as a join flag to the last added join with the position
   * BEFORE_TARGET
   *
   * @param flag join flag
   * @return the current object
   */
  @Override
  public Q addJoinFlag(String flag) {
    return addJoinFlag(flag, JoinFlag.Position.BEFORE_TARGET);
  }

  /**
   * Add the given String literal as a join flag to the last added join
   *
   * @param flag join flag
   * @param position position
   * @return the current object
   */
  @Override
  @SuppressWarnings("unchecked")
  public Q addJoinFlag(String flag, JoinFlag.Position position) {
    queryMixin.addJoinFlag(new JoinFlag(flag, position));
    return (Q) this;
  }

  /**
   * Add the given prefix and expression as a general query flag
   *
   * @param position position of the flag
   * @param prefix prefix for the flag
   * @param expr expression of the flag
   * @return the current object
   */
  @Override
  public Q addFlag(Position position, String prefix, Expression expr) {
    Expression flag = Expressions.template(expr.getType(), prefix + "{0}", expr);
    return queryMixin.addFlag(new QueryFlag(position, flag));
  }

  /**
   * Add the given query flag
   *
   * @param flag query flag
   * @return the current object
   */
  public Q addFlag(QueryFlag flag) {
    return queryMixin.addFlag(flag);
  }

  /**
   * Add the given String literal as query flag
   *
   * @param position position
   * @param flag query flag
   * @return the current object
   */
  @Override
  public Q addFlag(Position position, String flag) {
    return queryMixin.addFlag(new QueryFlag(position, flag));
  }

  /**
   * Add the given Expression as a query flag
   *
   * @param position position
   * @param flag query flag
   * @return the current object
   */
  @Override
  public Q addFlag(Position position, Expression flag) {
    return queryMixin.addFlag(new QueryFlag(position, flag));
  }

  @Override
  public long fetchCount() {
    queryMixin.setProjection(Wildcard.countAsInt);
    return ((Number) fetchOne()).longValue();
  }

  public Q from(Expression arg) {
    return queryMixin.from(arg);
  }

  public Q from(RelationalPath arg) {
    return queryMixin.from(arg);
  }

  public Q from(RelationalPath arg, Expression... args) {
    queryMixin.from(arg);
    return queryMixin.from(args);
  }

  @Override
  public Q from(RelationalPath... args) {
    return queryMixin.from(args);
  }

  @Override
  @SuppressWarnings({"unchecked", "rawtypes"})
  public Q from(SubQueryExpression subQuery, Path alias) {
    return queryMixin.from((Expression) ExpressionUtils.as((Expression) subQuery, alias));
  }

  @Override
  public Q fullJoin(EntityPath target) {
    return queryMixin.fullJoin(target);
  }

  @Override
  public  Q fullJoin(EntityPath target, Path alias) {
    return queryMixin.fullJoin(target, alias);
  }

  @Override
  public  Q fullJoin(RelationalFunctionCall target, Path alias) {
    return queryMixin.fullJoin(target, alias);
  }

  @Override
  public Q fullJoin(SubQueryExpression target, Path alias) {
    return queryMixin.fullJoin(target, alias);
  }

  @Override
  public  Q fullJoin(ForeignKey key, RelationalPath entity) {
    return queryMixin.fullJoin(entity).on(key.on(entity));
  }

  @Override
  public Q innerJoin(EntityPath target) {
    return queryMixin.innerJoin(target);
  }

  @Override
  public  Q innerJoin(EntityPath target, Path alias) {
    return queryMixin.innerJoin(target, alias);
  }

  @Override
  public  Q innerJoin(RelationalFunctionCall target, Path alias) {
    return queryMixin.innerJoin(target, alias);
  }

  @Override
  public Q innerJoin(SubQueryExpression target, Path alias) {
    return queryMixin.innerJoin(target, alias);
  }

  @Override
  public  Q innerJoin(ForeignKey key, RelationalPath entity) {
    return queryMixin.innerJoin(entity).on(key.on(entity));
  }

  @Override
  public Q join(EntityPath target) {
    return queryMixin.join(target);
  }

  @Override
  public  Q join(EntityPath target, Path alias) {
    return queryMixin.join(target, alias);
  }

  @Override
  public  Q join(RelationalFunctionCall target, Path alias) {
    return queryMixin.join(target, alias);
  }

  @Override
  public Q join(SubQueryExpression target, Path alias) {
    return queryMixin.join(target, alias);
  }

  @Override
  public  Q join(ForeignKey key, RelationalPath entity) {
    return queryMixin.join(entity).on(key.on(entity));
  }

  @Override
  public Q leftJoin(EntityPath target) {
    return queryMixin.leftJoin(target);
  }

  @Override
  public  Q leftJoin(EntityPath target, Path alias) {
    return queryMixin.leftJoin(target, alias);
  }

  @Override
  public  Q leftJoin(RelationalFunctionCall target, Path alias) {
    return queryMixin.leftJoin(target, alias);
  }

  @Override
  public Q leftJoin(SubQueryExpression target, Path alias) {
    return queryMixin.leftJoin(target, alias);
  }

  @Override
  public  Q leftJoin(ForeignKey key, RelationalPath entity) {
    return queryMixin.leftJoin(entity).on(key.on(entity));
  }

  @Override
  public Q rightJoin(EntityPath target) {
    return queryMixin.rightJoin(target);
  }

  @Override
  public  Q rightJoin(EntityPath target, Path alias) {
    return queryMixin.rightJoin(target, alias);
  }

  @Override
  public  Q rightJoin(RelationalFunctionCall target, Path alias) {
    return queryMixin.rightJoin(target, alias);
  }

  @Override
  public Q rightJoin(SubQueryExpression target, Path alias) {
    return queryMixin.rightJoin(target, alias);
  }

  @Override
  public  Q rightJoin(ForeignKey key, RelationalPath entity) {
    return queryMixin.rightJoin(entity).on(key.on(entity));
  }

  @SuppressWarnings("unchecked")
  private  Union innerUnion(SubQueryExpression... sq) {
    return innerUnion((List) Arrays.asList(sq));
  }

  @SuppressWarnings("unchecked")
  private  Union innerUnion(List> sq) {
    queryMixin.setProjection(sq.get(0).getMetadata().getProjection());
    if (!queryMixin.getMetadata().getJoins().isEmpty()) {
      throw new IllegalArgumentException("Don't mix union and from");
    }
    this.union = UnionUtils.union(sq, unionAll);
    this.firstUnionSubQuery = sq.get(0);
    return new UnionImpl(this);
  }

  public Q on(Predicate condition) {
    return queryMixin.on(condition);
  }

  @Override
  public Q on(Predicate... conditions) {
    return queryMixin.on(conditions);
  }

  /**
   * Creates an union expression for the given subqueries
   *
   * @param 
   * @param sq subqueries
   * @return union
   */
  public  Union union(SubQueryExpression... sq) {
    return innerUnion(sq);
  }

  /**
   * Creates an union expression for the given subqueries
   *
   * @param 
   * @param sq subqueries
   * @return union
   */
  public  Union union(List> sq) {
    return innerUnion(sq);
  }

  /**
   * Creates an union expression for the given subqueries
   *
   * @param 
   * @param alias alias for union
   * @param sq subqueries
   * @return the current object
   */
  @SuppressWarnings("unchecked")
  public  Q union(Path alias, SubQueryExpression... sq) {
    return from((Expression) UnionUtils.union(Arrays.asList(sq), (Path) alias, false));
  }

  /**
   * Creates an union expression for the given subqueries
   *
   * @param 
   * @param sq subqueries
   * @return union
   */
  public  Union unionAll(SubQueryExpression... sq) {
    unionAll = true;
    return innerUnion(sq);
  }

  /**
   * Creates an union expression for the given subqueries
   *
   * @param 
   * @param sq subqueries
   * @return union
   */
  public  Union unionAll(List> sq) {
    unionAll = true;
    return innerUnion(sq);
  }

  /**
   * Creates an union expression for the given subqueries
   *
   * @param 
   * @param alias alias for union
   * @param sq subqueries
   * @return the current object
   */
  @SuppressWarnings("unchecked")
  public  Q unionAll(Path alias, SubQueryExpression... sq) {
    return from((Expression) UnionUtils.union(Arrays.asList(sq), (Path) alias, true));
  }

  @Override
  public T fetchOne() throws NonUniqueResultException {
    if (getMetadata().getModifiers().getLimit() == null
        && !queryMixin.getMetadata().getProjection().toString().contains("count(")) {
      limit(2);
    }
    CloseableIterator iterator = iterate();
    return uniqueResult(iterator);
  }

  @Override
  public Q withRecursive(Path alias, SubQueryExpression query) {
    queryMixin.addFlag(new QueryFlag(QueryFlag.Position.WITH, SQLTemplates.RECURSIVE));
    return with(alias, query);
  }

  @Override
  public Q withRecursive(Path alias, Expression query) {
    queryMixin.addFlag(new QueryFlag(QueryFlag.Position.WITH, SQLTemplates.RECURSIVE));
    return with(alias, query);
  }

  @Override
  public WithBuilder withRecursive(Path alias, Path... columns) {
    queryMixin.addFlag(new QueryFlag(QueryFlag.Position.WITH, SQLTemplates.RECURSIVE));
    return with(alias, columns);
  }

  @Override
  public Q with(Path alias, SubQueryExpression query) {
    Expression expr =
        ExpressionUtils.operation(alias.getType(), SQLOps.WITH_ALIAS, alias, query);
    return queryMixin.addFlag(new QueryFlag(QueryFlag.Position.WITH, expr));
  }

  @Override
  public Q with(Path alias, Expression query) {
    Expression expr =
        ExpressionUtils.operation(alias.getType(), SQLOps.WITH_ALIAS, alias, query);
    return queryMixin.addFlag(new QueryFlag(QueryFlag.Position.WITH, expr));
  }

  @Override
  public WithBuilder with(Path alias, Path... columns) {
    Expression columnsCombined = ExpressionUtils.list(Object.class, columns);
    Expression aliasCombined =
        Expressions.operation(alias.getType(), SQLOps.WITH_COLUMNS, alias, columnsCombined);
    return new WithBuilder(queryMixin, aliasCombined);
  }

  protected void clone(Q query) {
    this.union = query.union;
    this.unionAll = query.unionAll;
    this.firstUnionSubQuery = query.firstUnionSubQuery;
  }

  @Override
  public abstract Q clone();

  protected abstract SQLSerializer createSerializer();

  private Set> getRootPaths(Collection> exprs) {
    Set> paths = new HashSet<>();
    for (Expression e : exprs) {
      Path path = e.accept(PathExtractor.DEFAULT, null);
      if (path != null && !path.getMetadata().isRoot()) {
        paths.add(path.getMetadata().getRootPath());
      }
    }
    return paths;
  }

  @SuppressWarnings("unchecked")
  private Collection> expandProjection(Expression expr) {
    if (expr instanceof FactoryExpression) {
      return ((FactoryExpression) expr).getArgs();
    } else {
      return Collections.singletonList(expr);
    }
  }

  @SuppressWarnings("unchecked")
  protected SQLSerializer serialize(boolean forCountRow) {
    SQLSerializer serializer = createSerializer();
    if (union != null) {
      if (queryMixin.getMetadata().getProjection() == null
          || expandProjection(queryMixin.getMetadata().getProjection())
              .equals(expandProjection(firstUnionSubQuery.getMetadata().getProjection()))) {
        serializer.serializeUnion(union, queryMixin.getMetadata(), unionAll);
      } else {
        QueryMixin mixin2 = new QueryMixin(queryMixin.getMetadata().clone());
        Set> paths = getRootPaths(expandProjection(mixin2.getMetadata().getProjection()));
        if (paths.isEmpty()) {
          mixin2.from(ExpressionUtils.as((Expression) union, defaultQueryAlias));
        } else if (paths.size() == 1) {
          mixin2.from(ExpressionUtils.as((Expression) union, paths.iterator().next()));
        } else {
          throw new IllegalStateException("Unable to create serialize union");
        }
        serializer.serialize(mixin2.getMetadata(), forCountRow);
      }
    } else {
      serializer.serialize(queryMixin.getMetadata(), forCountRow);
    }
    return serializer;
  }

  /**
   * Get the query as an SQL query string and bindings
   *
   * @return SQL string and bindings
   */
  public SQLBindings getSQL() {
    return getSQL(serialize(false));
  }

  protected SQLBindings getSQL(SQLSerializer serializer) {
    List