vxquery-core/src/main/java/org/apache/vxquery/compiler/rewriter/rules/ConsolidateDescandantChild.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.vxquery.compiler.rewriter.rules;

import java.util.List;

import org.apache.commons.lang3.mutable.Mutable;
import org.apache.vxquery.compiler.rewriter.rules.util.ExpressionToolbox;
import org.apache.vxquery.compiler.rewriter.rules.util.OperatorToolbox;
import org.apache.vxquery.functions.BuiltinOperators;

import org.apache.hyracks.algebricks.common.exceptions.AlgebricksException;
import org.apache.hyracks.algebricks.core.algebra.base.ILogicalExpression;
import org.apache.hyracks.algebricks.core.algebra.base.ILogicalOperator;
import org.apache.hyracks.algebricks.core.algebra.base.IOptimizationContext;
import org.apache.hyracks.algebricks.core.algebra.base.LogicalExpressionTag;
import org.apache.hyracks.algebricks.core.algebra.base.LogicalOperatorTag;
import org.apache.hyracks.algebricks.core.algebra.expressions.AbstractFunctionCallExpression;
import org.apache.hyracks.algebricks.core.algebra.expressions.VariableReferenceExpression;
import org.apache.hyracks.algebricks.core.algebra.operators.logical.AbstractUnnestOperator;
import org.apache.hyracks.algebricks.core.rewriter.base.IAlgebraicRewriteRule;

/**
 * The rule searches for assign operator with an aggregate function expression
 * immediately following an aggregate operator with a sequence expression.
 * XQuery aggregate functions are implemented in both scalar (one XDM Instance
 * input as a sequence) and iterative (a stream of XDM Instances each one is
 * single object).
 * 
 * <pre>
 * Before 
 * 
 *   plan__parent
 *   UNNEST( $v3 : fn:child( args[$v1], args[$filter]  ) )
 *   UNNEST( $v1 : fn:descandant( args[$v0] ) )
 *   plan__child
 *   
 * After
 * 
 *   plan__parent
 *   UNNEST( $v3 : fn:descandant( args[$v0], args[$filter] ) )
 *   plan__child
 * 
 * 
 * </pre>
 * 
 * @author shivanimall
 */

public class ConsolidateDescandantChild implements IAlgebraicRewriteRule {

    @Override
    public boolean rewritePre(Mutable<ILogicalOperator> opRef, IOptimizationContext context) throws AlgebricksException {
        return false;
    }

    @Override
    public boolean rewritePost(Mutable<ILogicalOperator> opRef, IOptimizationContext context)
            throws AlgebricksException {

        ILogicalOperator lo = opRef.getValue();
        if (!(lo.getOperatorTag().equals(LogicalOperatorTag.UNNEST))) {
            return false;
        }
        AbstractUnnestOperator auo = (AbstractUnnestOperator) lo;
        Mutable<ILogicalExpression> childExpression = ExpressionToolbox.findFirstFunctionExpression(
                auo.getExpressionRef(), BuiltinOperators.CHILD.getFunctionIdentifier());
        if (childExpression == null) {
            return false;
        }
        AbstractFunctionCallExpression childFnCall = (AbstractFunctionCallExpression) childExpression.getValue();
        List<Mutable<ILogicalExpression>> list = (List<Mutable<ILogicalExpression>>) childFnCall.getArguments();
        Mutable<ILogicalExpression> mle = (Mutable<ILogicalExpression>) (list).get(0);
        ILogicalExpression le = mle.getValue();
        if (!(le.getExpressionTag().equals(LogicalExpressionTag.VARIABLE))) {
            return false;
        }
        VariableReferenceExpression varLogicalExpression = (VariableReferenceExpression) le;
        Mutable<ILogicalOperator> lop = OperatorToolbox.findProducerOf(opRef,
                varLogicalExpression.getVariableReference());
        ILogicalOperator lop1 = lop.getValue();
        if (!(lop1.getOperatorTag().equals(LogicalOperatorTag.UNNEST))) {
            return false;
        }
        if (OperatorToolbox.getExpressionOf(lop, varLogicalExpression.getVariableReference()) == null) {
            return false;
        }
        ILogicalExpression variableLogicalExpression = (ILogicalExpression) OperatorToolbox.getExpressionOf(lop,
                varLogicalExpression.getVariableReference()).getValue();
        if (!(variableLogicalExpression.getExpressionTag().equals(LogicalExpressionTag.FUNCTION_CALL))) {
            return false;
        }
        AbstractFunctionCallExpression afce = (AbstractFunctionCallExpression) variableLogicalExpression;
        if (!(afce.getFunctionIdentifier().equals(BuiltinOperators.DESCENDANT_OR_SELF.getFunctionIdentifier()))) {
            return false;
        }
        //All conditions have been met.
        childFnCall.setFunctionInfo(BuiltinOperators.DESCENDANT_OR_SELF);
        childFnCall.getArguments().get(0).setValue(afce.getArguments().get(0).getValue());
        ILogicalOperator lo1 = opRef.getValue();
        Mutable<ILogicalOperator> mlistOfLo = lo1.getInputs().get(0).getValue().getInputs().get(0);
        ILogicalOperator ilo = (ILogicalOperator) mlistOfLo.getValue();
        lo.getInputs().get(0).setValue((ILogicalOperator) ilo);
        return true;
    }
}