All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.querydsl.jpa.sql.AbstractJPASQLQuery Maven / Gradle / Ivy

    There is a newer version: 6.10.1
    Show newest version
    /*
 * 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.jpa.sql;

import com.mysema.commons.lang.CloseableIterator;
import com.querydsl.core.*;
import com.querydsl.core.types.Expression;
import com.querydsl.core.types.FactoryExpression;
import com.querydsl.jpa.AbstractSQLQuery;
import com.querydsl.jpa.NativeSQLSerializer;
import com.querydsl.jpa.QueryHandler;
import com.querydsl.jpa.impl.JPAProvider;
import com.querydsl.jpa.impl.JPAUtil;
import com.querydsl.sql.Configuration;
import com.querydsl.sql.SQLSerializer;
import jakarta.persistence.EntityManager;
import jakarta.persistence.FlushModeType;
import jakarta.persistence.LockModeType;
import jakarta.persistence.Query;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Stream;
import org.jetbrains.annotations.Nullable;

/**
 * {@code AbstractJPASQLQuery} is the base class for JPA Native SQL queries
 *
 * @param  result type
 * @param  concrete subtype
 * @author tiwe*
 */
public abstract class AbstractJPASQLQuery>
    extends AbstractSQLQuery {

  private static final Logger logger = Logger.getLogger(AbstractJPASQLQuery.class.getName());

  private final EntityManager entityManager;

  protected final Map hints = new LinkedHashMap<>();

  protected final QueryHandler queryHandler;

  @Nullable protected LockModeType lockMode;

  @Nullable protected FlushModeType flushMode;

  @Nullable protected FactoryExpression projection;

  public AbstractJPASQLQuery(EntityManager em, Configuration configuration) {
    this(em, configuration, new DefaultQueryMetadata());
  }

  public AbstractJPASQLQuery(
      EntityManager em, Configuration configuration, QueryHandler queryHandler) {
    this(em, configuration, queryHandler, new DefaultQueryMetadata());
  }

  public AbstractJPASQLQuery(
      EntityManager em, Configuration configuration, QueryMetadata metadata) {
    this(em, configuration, JPAProvider.getTemplates(em).getQueryHandler(), metadata);
  }

  public AbstractJPASQLQuery(
      EntityManager em,
      Configuration configuration,
      QueryHandler queryHandler,
      QueryMetadata metadata) {
    super(metadata, configuration);
    this.entityManager = em;
    this.queryHandler = queryHandler;
  }

  public Query createQuery() {
    return createQuery(false);
  }

  private Query createQuery(boolean forCount) {
    NativeSQLSerializer serializer = (NativeSQLSerializer) serialize(forCount);
    String queryString = serializer.toString();
    logQuery(queryString);
    Expression projection = queryMixin.getMetadata().getProjection();
    Query query;

    if (!FactoryExpression.class.isAssignableFrom(projection.getClass())
        && isEntityExpression(projection)) {
      if (queryHandler.createNativeQueryTyped()) {
        query = entityManager.createNativeQuery(queryString, projection.getType());
      } else {
        query = entityManager.createNativeQuery(queryString);
      }

    } else {
      query = entityManager.createNativeQuery(queryString);
    }
    if (!forCount) {
      Map, List> aliases = serializer.getAliases();
      Set used = new HashSet<>();
      if (projection instanceof FactoryExpression) {
        for (Expression expr : ((FactoryExpression) projection).getArgs()) {
          if (isEntityExpression(expr)) {
            queryHandler.addEntity(query, extractEntityExpression(expr).toString(), expr.getType());
          } else if (aliases.containsKey(expr)) {
            for (String scalar : aliases.get(expr)) {
              if (!used.contains(scalar)) {
                queryHandler.addScalar(query, scalar, expr.getType());
                used.add(scalar);
                break;
              }
            }
          }
        }
      } else if (isEntityExpression(projection)) {
        queryHandler.addEntity(
            query, extractEntityExpression(projection).toString(), projection.getType());
      } else if (aliases.containsKey(projection)) {
        for (String scalar : aliases.get(projection)) {
          if (!used.contains(scalar)) {
            queryHandler.addScalar(query, scalar, projection.getType());
            used.add(scalar);
            break;
          }
        }
      }
    }

    if (lockMode != null) {
      query.setLockMode(lockMode);
    }
    if (flushMode != null) {
      query.setFlushMode(flushMode);
    }

    for (Map.Entry entry : hints.entrySet()) {
      query.setHint(entry.getKey(), entry.getValue());
    }

    // set constants
    JPAUtil.setConstants(query, serializer.getConstants(), queryMixin.getMetadata().getParams());
    this.projection = null; // necessary when query is reused

    if (!forCount && projection instanceof FactoryExpression) {
      if (!queryHandler.transform(query, (FactoryExpression) projection)) {
        this.projection = (FactoryExpression) projection;
      }
    }

    return query;
  }

  @Override
  protected SQLSerializer createSerializer() {
    return new NativeSQLSerializer(configuration, queryHandler.wrapEntityProjections());
  }

  /**
   * Transforms results using FactoryExpression if ResultTransformer can't be used
   *
   * @param query query
   * @return results
   */
  private List getResultList(Query query) {
    // TODO : use lazy fetch here?
    if (projection != null) {
      List results = query.getResultList();
      List rv = new ArrayList(results.size());
      for (Object o : results) {
        if (o != null) {
          Object[] arr;
          if (!o.getClass().isArray()) {
            arr = new Object[] {o};
          } else {
            arr = (Object[]) o;
          }
          if (projection.getArgs().size() < arr.length) {
            Object[] shortened = new Object[projection.getArgs().size()];
            System.arraycopy(arr, 0, shortened, 0, shortened.length);
            arr = shortened;
          }
          rv.add(projection.newInstance(arr));
        } else {
          rv.add(null);
        }
      }
      return rv;
    } else {
      return query.getResultList();
    }
  }

  /**
   * Transforms results using FactoryExpression if ResultTransformer can't be used
   *
   * @param query query
   * @return single result
   */
  @Nullable
  private Object getSingleResult(Query query) {
    if (projection != null) {
      Object result = query.getSingleResult();
      if (result != null) {
        if (!result.getClass().isArray()) {
          result = new Object[] {result};
        }
        return projection.newInstance((Object[]) result);
      } else {
        return null;
      }
    } else {
      return query.getSingleResult();
    }
  }

  @SuppressWarnings("unchecked")
  @Override
  public List fetch() {
    try {
      Query query = createQuery();
      return (List) getResultList(query);
    } finally {
      reset();
    }
  }

  @Override
  public CloseableIterator iterate() {
    try {
      Query query = createQuery();
      return queryHandler.iterate(query, null);
    } finally {
      reset();
    }
  }

  @Override
  @SuppressWarnings("unchecked")
  public Stream stream() {
    try {
      Query query = createQuery();
      return query.getResultStream();
    } finally {
      reset();
    }
  }

  @Override
  public QueryResults fetchResults() {
    // TODO : handle entity projections as well
    try {
      Query countQuery = createQuery(true);
      long total = ((Number) countQuery.getSingleResult()).longValue();
      if (total > 0) {
        QueryModifiers modifiers = queryMixin.getMetadata().getModifiers();
        Query query = createQuery(false);
        @SuppressWarnings("unchecked")
        List list = (List) getResultList(query);
        return new QueryResults(list, modifiers, total);
      } else {
        return QueryResults.emptyResults();
      }
    } finally {
      reset();
    }
  }

  protected void logQuery(String queryString) {
    if (logger.isLoggable(Level.FINE)) {
      String normalizedQuery = queryString.replace('\n', ' ');
      logger.fine(normalizedQuery);
    }
  }

  protected void reset() {}

  @Override
  @SuppressWarnings("unchecked")
  public T fetchOne() throws NonUniqueResultException {
    Query query = createQuery();
    return (T) uniqueResult(query);
  }

  @Nullable
  private Object uniqueResult(Query query) {
    try {
      return getSingleResult(query);
    } catch (jakarta.persistence.NoResultException e) {
      logger.log(Level.FINEST, e.getMessage(), e);
      return null;
    } catch (jakarta.persistence.NonUniqueResultException e) {
      throw new NonUniqueResultException(e);
    } finally {
      reset();
    }
  }

  @SuppressWarnings("unchecked")
  public Q setLockMode(LockModeType lockMode) {
    this.lockMode = lockMode;
    return (Q) this;
  }

  @SuppressWarnings("unchecked")
  public Q setFlushMode(FlushModeType flushMode) {
    this.flushMode = flushMode;
    return (Q) this;
  }

  @SuppressWarnings("unchecked")
  public Q setHint(String name, Object value) {
    hints.put(name, value);
    return (Q) this;
  }

  @Override
  protected void clone(Q query) {
    super.clone(query);
    flushMode = query.flushMode;
    hints.putAll(query.hints);
    lockMode = query.lockMode;
    projection = query.projection;
  }

  public abstract Q clone(EntityManager entityManager);

  @Override
  public Q clone() {
    return this.clone(this.entityManager);
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy