org.hibernate.hql.spi.QueryTranslator.java Source code

Introduction

Here is the source code for org.hibernate.hql.spi.QueryTranslator.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.hql.spi;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.hibernate.HibernateException;
import org.hibernate.MappingException;
import org.hibernate.QueryException;
import org.hibernate.engine.spi.QueryParameters;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.event.spi.EventSource;
import org.hibernate.query.spi.ScrollableResultsImplementor;
import org.hibernate.type.Type;

/**
 * Defines the contract of an HQL->SQL translator.
 *
 * @author josh
 */
public interface QueryTranslator {
    String ERROR_CANNOT_FETCH_WITH_ITERATE = "fetch may not be used with scroll() or iterate()";
    String ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR = "Named parameter does not appear in Query: ";
    String ERROR_ORDINAL_PARAMETER_DOES_NOT_APPEAR = "Ordinal parameter [%s] does not appear in Query [%s] ";
    String ERROR_LEGACY_ORDINAL_PARAMS_NO_LONGER_SUPPORTED = "Legacy-style query parameters (`?`) are no longer supported; use JPA-style ordinal parameters (e.g., `?1`) instead : %s";
    String ERROR_CANNOT_DETERMINE_TYPE = "Could not determine type of: ";
    String ERROR_CANNOT_FORMAT_LITERAL = "Could not format constant value to SQL literal: ";

    /**
     * Compile a "normal" query. This method may be called multiple
     * times. Subsequent invocations are no-ops.
     *
     * @param replacements Defined query substitutions.
     * @param shallow      Does this represent a shallow (scalar or entity-id) select?
     * @throws QueryException   There was a problem parsing the query string.
     * @throws MappingException There was a problem querying defined mappings.
     */
    void compile(Map replacements, boolean shallow) throws QueryException, MappingException;

    /**
     * Perform a list operation given the underlying query definition.
     *
     * @param session         The session owning this query.
     * @param queryParameters The query bind parameters.
     * @return The query list results.
     * @throws HibernateException
     */
    List list(SharedSessionContractImplementor session, QueryParameters queryParameters) throws HibernateException;

    /**
     * Perform an iterate operation given the underlying query definition.
     *
     * @param queryParameters The query bind parameters.
     * @param session         The session owning this query.
     * @return An iterator over the query results.
     * @throws HibernateException
     */
    Iterator iterate(QueryParameters queryParameters, EventSource session) throws HibernateException;

    /**
     * Perform a scroll operation given the underlying query definition.
     *
     * @param queryParameters The query bind parameters.
     * @param session         The session owning this query.
     * @return The ScrollableResults wrapper around the query results.
     * @throws HibernateException
     */
    ScrollableResultsImplementor scroll(QueryParameters queryParameters, SharedSessionContractImplementor session)
            throws HibernateException;

    /**
     * Perform a bulk update/delete operation given the underlying query definition.
     *
     * @param queryParameters The query bind parameters.
     * @param session         The session owning this query.
     * @return The number of entities updated or deleted.
     * @throws HibernateException
     */
    int executeUpdate(QueryParameters queryParameters, SharedSessionContractImplementor session)
            throws HibernateException;

    /**
     * Returns the set of query spaces (table names) that the query refers to.
     *
     * @return A set of query spaces (table names).
     */
    Set<Serializable> getQuerySpaces();

    /**
     * Retrieve the query identifier for this translator.  The query identifier is
     * used in states collection.
     *
     * @return the identifier
     */
    String getQueryIdentifier();

    /**
     * Returns the SQL string generated by the translator.
     *
     * @return the SQL string generated by the translator.
     */
    String getSQLString();

    List<String> collectSqlStrings();

    /**
     * Returns the HQL string processed by the translator.
     *
     * @return the HQL string processed by the translator.
     */
    String getQueryString();

    /**
     * Returns the filters enabled for this query translator.
     *
     * @return Filters enabled for this query execution.
     */
    Map getEnabledFilters();

    /**
     * Returns an array of Types represented in the query result.
     *
     * @return Query return types.
     */
    Type[] getReturnTypes();

    /**
     * Returns an array of HQL aliases
     */
    String[] getReturnAliases();

    /**
     * Returns the column names in the generated SQL.
     *
     * @return the column names in the generated SQL.
     */
    String[][] getColumnNames();

    /**
     * Return information about any parameters encountered during
     * translation.
     *
     * @return The parameter information.
     */
    ParameterTranslations getParameterTranslations();

    /**
     * Validate the scrollability of the translated query.
     *
     * @throws HibernateException
     */
    void validateScrollability() throws HibernateException;

    /**
     * Does the translated query contain collection fetches?
     *
     * @return true if the query does contain collection fetched;
     * false otherwise.
     */
    boolean containsCollectionFetches();

    boolean isManipulationStatement();

    default boolean isUpdateStatement() {
        return getQueryString().toLowerCase().trim().startsWith("update");
    }

    default List<String> getPrimaryFromClauseTables() {
        return new ArrayList<>();
    }

    Class getDynamicInstantiationResultType();
}