/*
 * Copyright 2009-2010 by The Regents of the University of California
 * 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 from
 * 
 *     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 edu.uci.ics.hyracks.algebricks.core.algebra.base;

import java.util.List;
import java.util.Map;

import edu.uci.ics.hyracks.algebricks.common.exceptions.AlgebricksException;
import edu.uci.ics.hyracks.algebricks.core.algebra.expressions.IExpressionEvalSizeComputer;
import edu.uci.ics.hyracks.algebricks.core.algebra.expressions.IMergeAggregationExpressionFactory;
import edu.uci.ics.hyracks.algebricks.core.algebra.expressions.IVariableEvalSizeEnvironment;
import edu.uci.ics.hyracks.algebricks.core.algebra.metadata.IMetadataProvider;
import edu.uci.ics.hyracks.algebricks.core.algebra.properties.FunctionalDependency;
import edu.uci.ics.hyracks.algebricks.core.algebra.properties.ILogicalPropertiesVector;
import edu.uci.ics.hyracks.algebricks.core.algebra.typing.ITypingContext;
import edu.uci.ics.hyracks.algebricks.core.rewriter.base.IAlgebraicRewriteRule;
import edu.uci.ics.hyracks.algebricks.core.rewriter.base.PhysicalOptimizationConfig;

public interface IOptimizationContext extends ITypingContext {

    public abstract int getVarCounter();

    // -1 if unknown
    public abstract int getFrameSize();

    public abstract void setVarCounter(int varCounter);

    public abstract LogicalVariable newVar();

    public abstract IMetadataProvider<?, ?> getMetadataProvider();

    public abstract void setMetadataDeclarations(IMetadataProvider<?, ?> metadataProvider);

    public abstract boolean checkIfInDontApplySet(IAlgebraicRewriteRule rule, ILogicalOperator op);

    public abstract void addToDontApplySet(IAlgebraicRewriteRule rule, ILogicalOperator op);

    /*
     * returns true if op1 and op2 have already been compared
     */
    public abstract boolean checkAndAddToAlreadyCompared(ILogicalOperator op1, ILogicalOperator op2);
    
    public abstract void removeFromAlreadyCompared(ILogicalOperator op1);

    public abstract void addNotToBeInlinedVar(LogicalVariable var);

    public abstract boolean shouldNotBeInlined(LogicalVariable var);

    public abstract void addPrimaryKey(FunctionalDependency pk);

    public abstract List<LogicalVariable> findPrimaryKey(LogicalVariable recordVar);

    public abstract void putEquivalenceClassMap(ILogicalOperator op, Map<LogicalVariable, EquivalenceClass> eqClassMap);

    public abstract Map<LogicalVariable, EquivalenceClass> getEquivalenceClassMap(ILogicalOperator op);

    public abstract void putFDList(ILogicalOperator op, List<FunctionalDependency> fdList);

    public abstract List<FunctionalDependency> getFDList(ILogicalOperator op);

    public abstract void putLogicalPropertiesVector(ILogicalOperator op, ILogicalPropertiesVector v);

    public abstract ILogicalPropertiesVector getLogicalPropertiesVector(ILogicalOperator op);

    public abstract IExpressionEvalSizeComputer getExpressionEvalSizeComputer();

    public abstract IVariableEvalSizeEnvironment getVariableEvalSizeEnvironment();

    public abstract IMergeAggregationExpressionFactory getMergeAggregationExpressionFactory();

    public abstract PhysicalOptimizationConfig getPhysicalOptimizationConfig();

    public abstract void invalidateTypeEnvironmentForOperator(ILogicalOperator op);

    public abstract void computeAndSetTypeEnvironmentForOperator(ILogicalOperator op) throws AlgebricksException;

    public abstract void updatePrimaryKeys(Map<LogicalVariable, LogicalVariable> mappedVars);
}