/*
 * 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.ode.bpel.compiler.api;

import java.net.URI;
import java.util.List;
import java.util.Map;

import javax.wsdl.Operation;
import javax.xml.namespace.QName;
import javax.xml.transform.Source;

import org.apache.ode.bpel.compiler.bom.Activity;
import org.apache.ode.bpel.compiler.bom.Expression;
import org.apache.ode.bpel.compiler.bom.ScopeLikeActivity;
import org.apache.ode.bpel.obj.OActivity;
import org.apache.ode.bpel.obj.OExpression;
import org.apache.ode.bpel.obj.OLValueExpression;
import org.apache.ode.bpel.obj.OLink;
import org.apache.ode.bpel.obj.OMessageVarType;
import org.apache.ode.bpel.obj.OPartnerLink;
import org.apache.ode.bpel.obj.OProcess;
import org.apache.ode.bpel.obj.OScope;
import org.apache.ode.bpel.obj.OVarType;
import org.apache.ode.bpel.obj.OXsdTypeVarType;
import org.apache.ode.bpel.obj.OXslSheet;
import org.apache.ode.bpel.obj.OScope.Variable;
import org.apache.ode.utils.NSContext;


/**
 * Interface providing access to the compiler.
 *
 * @author Maciej Szefler ( m s z e f l e r @ g m a i l . c o m )
 */
public interface CompilerContext {

    OExpression constantExpr(boolean value);

    OExpression compileJoinCondition(Expression expr)
            throws CompilationException;

    OExpression compileExpr(Expression expr)
    throws CompilationException;

    OExpression compileExpr(Expression expr, OVarType rootNodeType, Object requestedResultType, Object[] resultType)
            throws CompilationException;

    OLValueExpression compileLValueExpr(Expression expr)
    throws CompilationException;

    OLValueExpression compileLValueExpr(Expression expr, OVarType rootNodeType, Object requestedResultType, Object[] resultType)
            throws CompilationException;

    /**
     * BPEL 1.1 legacy.
     * @param locationstr
     * @param nsContext
     * @return
     * @throws CompilationException
     */
    OExpression compileExpr(String locationstr, NSContext nsContext)
            throws CompilationException;

    OXslSheet compileXslt(String docStrUri)
            throws CompilationException;

    OXsdTypeVarType resolveXsdType(QName typeName)
            throws CompilationException;

    OProcess.OProperty resolveProperty(QName name)
            throws CompilationException;

    OScope.Variable resolveVariable(String name)
            throws CompilationException;

    List<OScope.Variable> getAccessibleVariables();

    OScope.Variable resolveMessageVariable(String inputVar)
            throws CompilationException;

    OScope.Variable resolveMessageVariable(String inputVar, QName messageType)
            throws CompilationException;

    OMessageVarType.Part resolvePart(OScope.Variable variable, String partname)
            throws CompilationException;

    OMessageVarType.Part resolveHeaderPart(OScope.Variable variable, String partname)
            throws CompilationException;

    OActivity compile(Activity child)
            throws CompilationException;

    OScope compileSLC(ScopeLikeActivity child, Variable[] variables);

    OPartnerLink resolvePartnerLink(String name)
            throws CompilationException;

    Operation resolvePartnerRoleOperation(OPartnerLink partnerLink, String operationName)
            throws CompilationException;

    Operation resolveMyRoleOperation(OPartnerLink partnerLink, String operationName)
            throws CompilationException;

    OProcess.OPropertyAlias resolvePropertyAlias(OScope.Variable variable, QName property)
            throws CompilationException;

    void recoveredFromError(SourceLocation where, CompilationException bce)
            throws CompilationException;

    OLink resolveLink(String linkName)
            throws CompilationException;

    OScope resolveCompensatableScope(String scopeToCompensate)
            throws CompilationException;

    OProcess getOProcess()
            throws CompilationException;

    OScope.CorrelationSet resolveCorrelationSet(String csetName)
            throws CompilationException;

    String getSourceLocation();

    boolean isPartnerLinkAssigned(String plink);

    List<OActivity> getActivityStack();

    OActivity getCurrent();

    Map<URI, Source> getSchemaSources();

    boolean isExtensionDeclared(String namespace);

    /**
     * Retrieves the base URI that the BPEL Process execution contextis running relative to.
     *
     * @return URI - the URI representing the absolute physical file path location that this process is defined within.
     */
    URI getBaseResourceURI();

    public NSContext tryCacheNamespaceContext(NSContext nsContext);
}