com.blazebit.persistence.impl.GroupByManager Maven / Gradle / Ivy

/*
 * Copyright 2014 - 2020 Blazebit.
 *
 * 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.blazebit.persistence.impl;

import com.blazebit.persistence.parser.SimpleQueryGenerator;
import com.blazebit.persistence.parser.expression.Expression;
import com.blazebit.persistence.parser.expression.Expression.Visitor;
import com.blazebit.persistence.parser.expression.ExpressionCopyContext;
import com.blazebit.persistence.parser.expression.modifier.ExpressionModifier;
import com.blazebit.persistence.impl.transform.ExpressionModifierVisitor;
import com.blazebit.persistence.spi.JpaProvider;

import java.util.ArrayList;
import java.util.EnumSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 *
 * @author Christian Beikov
 * @author Moritz Becker
 * @since 1.0.0
 */
public class GroupByManager extends AbstractManager {

    private final JpaProvider jpaProvider;
    private final ImplicitGroupByClauseDependencyRegistrationVisitor implicitGroupByClauseDependencyRegistrationVisitor;
    private final EmbeddableSplittingVisitor embeddableSplittingVisitor;
    private final GroupByExpressionGatheringVisitor groupByExpressionGatheringVisitor;

    /**
     * We use an ArrayList since a HashSet causes problems when the path reference in the expression is changed
     * after it was inserted into the set (e.g. when implicit joining is performed).
     */
    private final List groupByInfos;
    // These are the collected group by clauses
    private final Map> groupByClauses;

    GroupByManager(ResolvingQueryGenerator queryGenerator, ParameterManager parameterManager, SubqueryInitiatorFactory subqueryInitFactory, JpaProvider jpaProvider, AliasManager aliasManager, EmbeddableSplittingVisitor embeddableSplittingVisitor, GroupByExpressionGatheringVisitor groupByExpressionGatheringVisitor) {
        super(queryGenerator, parameterManager, subqueryInitFactory);
        this.jpaProvider = jpaProvider;
        this.implicitGroupByClauseDependencyRegistrationVisitor = new ImplicitGroupByClauseDependencyRegistrationVisitor(aliasManager);
        this.embeddableSplittingVisitor = embeddableSplittingVisitor;
        this.groupByExpressionGatheringVisitor = groupByExpressionGatheringVisitor;
        this.groupByInfos = new ArrayList<>();
        this.groupByClauses = new LinkedHashMap<>();
    }

    void applyFrom(GroupByManager groupByManager, Set excludedClauses, ExpressionCopyContext copyContext) {
        if (excludedClauses.isEmpty() || groupByClauses.isEmpty()) {
            for (NodeInfo info : groupByManager.groupByInfos) {
                groupBy(subqueryInitFactory.reattachSubqueries(info.getExpression().copy(copyContext), ClauseType.GROUP_BY));
            }
        } else {
            for (Map.Entry> entry : groupByClauses.entrySet()) {
                if (!excludedClauses.containsAll(entry.getValue())) {
                    groupBy(subqueryInitFactory.reattachSubqueries(entry.getKey().getExpression().copy(copyContext), ClauseType.GROUP_BY));
                }
            }
        }
    }

    @Override
    public ClauseType getClauseType() {
        return ClauseType.GROUP_BY;
    }

    public void groupBy(Expression expr) {
        groupByInfos.add(new NodeInfo(expr));
        registerParameterExpressions(expr);
    }
    
    void collectGroupByClauses(JoinVisitor joinVisitor) {
        if (groupByInfos.isEmpty()) {
            return;
        }

        SimpleQueryGenerator.BooleanLiteralRenderingContext oldBooleanLiteralRenderingContext = queryGenerator.setBooleanLiteralRenderingContext(SimpleQueryGenerator.BooleanLiteralRenderingContext.CASE_WHEN);
        StringBuilder sb = new StringBuilder();

        queryGenerator.setClauseType(ClauseType.GROUP_BY);
        queryGenerator.setQueryBuffer(sb);
        for (NodeInfo info : groupByInfos) {
            Expression expr = info.getExpression();
            Set collectedExpressions = groupByExpressionGatheringVisitor.extractGroupByExpressions(expr);
            if (collectedExpressions.size() > 1 || collectedExpressions.iterator().next() != expr) {
                throw new RuntimeException("The complex group by expression [" + expr + "] is not supported by the underlying database. The valid sub-expressions are: " + collectedExpressions);
            }
            sb.setLength(0);
            queryGenerator.generate(expr);
            collect(new ResolvedExpression(sb.toString(), expr), ClauseType.GROUP_BY, true, joinVisitor);
        }
        queryGenerator.setBooleanLiteralRenderingContext(oldBooleanLiteralRenderingContext);
        queryGenerator.setClauseType(null);
    }

    void buildGroupBy(StringBuilder sb) {
        buildGroupBy(sb, EnumSet.noneOf(ClauseType.class));
    }

    void buildGroupBy(StringBuilder sb, Set excludedClauses) {
        if (!groupByClauses.isEmpty()) {
            queryGenerator.setClauseType(ClauseType.GROUP_BY);
            queryGenerator.setQueryBuffer(sb);
            int initialIndex = sb.length();
            sb.append(" GROUP BY ");
            int emptyIndex = sb.length();
            for (Map.Entry> entry : groupByClauses.entrySet()) {
                if (!excludedClauses.containsAll(entry.getValue())) {
                    entry.getKey().getExpression().accept(queryGenerator);
                    sb.append(", ");
                }
            }

            if (sb.length() == emptyIndex) {
                sb.setLength(initialIndex);
            } else {
                sb.setLength(sb.length() - 2);
            }
        }
    }

    void buildGroupBy(StringBuilder sb, Set excludedClauses, ResolvedExpression[] additionalGroupBys) {
        queryGenerator.setClauseType(ClauseType.GROUP_BY);
        queryGenerator.setQueryBuffer(sb);
        if (groupByClauses.isEmpty()) {
            if (additionalGroupBys.length != 0) {
                sb.append(" GROUP BY ");
                for (ResolvedExpression additionalGroupBy : additionalGroupBys) {
                    additionalGroupBy.getExpression().accept(queryGenerator);
                    sb.append(", ");
                }
                sb.setLength(sb.length() - 2);
            }
        } else {
            int initialIndex = sb.length();
            sb.append(" GROUP BY ");
            int emptyIndex = sb.length();
            for (Map.Entry> entry : groupByClauses.entrySet()) {
                if (!excludedClauses.containsAll(entry.getValue())) {
                    entry.getKey().getExpression().accept(queryGenerator);
                    sb.append(", ");
                }
            }

            if (additionalGroupBys.length == 0) {
                if (sb.length() == emptyIndex) {
                    sb.setLength(initialIndex);
                } else {
                    sb.setLength(sb.length() - 2);
                }
            } else {
                for (ResolvedExpression additionalGroupBy : additionalGroupBys) {
                    Set clauseTypes = groupByClauses.get(additionalGroupBy);
                    if ((clauseTypes == null || excludedClauses.containsAll(clauseTypes))) {
                        additionalGroupBy.getExpression().accept(queryGenerator);
                        sb.append(", ");
                    }
                }
                sb.setLength(sb.length() - 2);
            }
        }
    }

    @Override
    public void apply(ExpressionModifierVisitor visitor) {
        List infos = groupByInfos;
        int size = infos.size();
        for (int i = 0; i < size; i++) {
            final NodeInfo groupBy = infos.get(i);
            visitor.visit(groupBy, ClauseType.GROUP_BY);
        }
    }

    void acceptVisitor(Visitor v) {
        for (NodeInfo groupBy : groupByInfos) {
            groupBy.getExpression().accept(v);
        }
    }

    public boolean hasGroupBys() {
        return groupByInfos.size() > 0;
    }

    boolean isEmpty() {
        return groupByInfos.isEmpty();
    }

    public void resetCollected() {
        groupByClauses.clear();
    }

    public void collect(ResolvedExpression expression, ClauseType clauseType, boolean hasGroupBy, JoinVisitor joinVisitor) {
        List expressions = embeddableSplittingVisitor.splitOff(expression.getExpression());
        if (expressions != null) {
            if (expressions.isEmpty()) {
                collect0(expression, clauseType, hasGroupBy);
            } else {
                if (jpaProvider.supportsSingleValuedAssociationIdExpressions() || joinVisitor == null) {
                    for (Expression splitOffExpression : expressions) {
                        ResolvedExpression subExpression = new ResolvedExpression(splitOffExpression.toString(), splitOffExpression);
                        collect0(subExpression, clauseType, hasGroupBy);
                    }
                } else {
                    // When we don't support single valued id access, we need to do an implicit join as the embeddable might contain an association
                    ClauseType fromClause = joinVisitor.getFromClause();
                    try {
                        joinVisitor.setFromClause(clauseType);
                        for (Expression splitOffExpression : expressions) {
                            if (hasGroupBy) {
                                splitOffExpression.accept(joinVisitor);
                            }
                            ResolvedExpression subExpression = new ResolvedExpression(splitOffExpression.toString(), splitOffExpression);
                            collect0(subExpression, clauseType, hasGroupBy);
                        }
                    } finally {
                        joinVisitor.setFromClause(fromClause);
                    }
                }
            }
        }
    }

    private void collect0(ResolvedExpression expression, ClauseType clauseType, boolean hasGroupBy) {
        Set clauseTypes = groupByClauses.get(expression);
        if (clauseTypes == null) {
            clauseTypes = EnumSet.of(clauseType);
            if (hasGroupBy) {
                expression.getExpression().accept(implicitGroupByClauseDependencyRegistrationVisitor);
            }
            groupByClauses.put(expression, clauseTypes);
        } else {
            clauseTypes.add(clauseType);
        }
    }

    public void collect(ResolvedExpression expression, Set newClauseTypes) {
        Set clauseTypes = groupByClauses.get(expression);
        if (clauseTypes == null) {
            clauseTypes = EnumSet.copyOf(newClauseTypes);
            expression.getExpression().accept(implicitGroupByClauseDependencyRegistrationVisitor);
            groupByClauses.put(expression, clauseTypes);
        } else {
            clauseTypes.addAll(newClauseTypes);
        }
    }

    public Map> getCollectedGroupByClauses() {
        return groupByClauses;
    }

    public boolean hasCollectedGroupByClauses() {
        return groupByClauses.size() != 0;
    }

    public boolean hasCollectedGroupByClauses(Set excludedClauses) {
        for (Map.Entry> entry : groupByClauses.entrySet()) {
            if (!excludedClauses.containsAll(entry.getValue())) {
                return true;
            }
        }
        return false;
    }

    @Override
    public int hashCode() {
        int hash = 5;
        hash = 89 * hash + (this.groupByInfos != null ? this.groupByInfos.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final GroupByManager other = (GroupByManager) obj;
        if (this.groupByInfos != other.groupByInfos && (this.groupByInfos == null || !this.groupByInfos.equals(other.groupByInfos))) {
            return false;
        }
        return true;
    }

}