/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.core.query;

import org.eclipse.emf.ecore.EObject;
import org.teiid.designer.query.metadata.IQueryMetadataInterface;


/** 
 * QueryValidator, a helper utility that validate the sql and returns a result.
 *
 * @since 8.0
 */
public interface QueryValidator {
    
    public enum ElementSymbolOptimization {
        OPTIMIZED,
        DEOPTIMIZED,
        UNMODIFIED
    }

    //================================================================================================//
    // Constants
    //================================================================================================//
    int SELECT_TRNS = 0;
    int INSERT_TRNS = 1;
    int UPDATE_TRNS = 2;
    int DELETE_TRNS = 3;
    int UNKNOWN_TRNS = -1;
    int ALL_UPDATE_SQL_PROBLEM = 699;
    int INSERT_SQL_PROBLEM = 700;
    int UPDATE_SQL_PROBLEM = 701;
    int DELETE_SQL_PROBLEM = 702;

    /**
     * Validate the sqlString of the given type, valid types are 
     * {@link #SELECT_TRNS}, {@link #INSERT_TRNS}, {@link #UPDATE_TRNS}, {@link #DELETE_TRNS}
     * {@link #UNKNOWN_TRNS}, if this is a unknown transform, the query will only be parsed.
     * @param sqlString The sqlString that needs to be validate
     * @param type The type of sql being passed in
     * @param cacheResult Boolean to determine if the result needs to be cached.
     * @return The ValidationResult.
     */
    QueryValidationResult validateSql(String sqlString, int type, boolean cacheResult);
    
    /**
     * The QueryMetadataInterface used to validate the sql.
     * @return QueryMetadataInterface
     */
    IQueryMetadataInterface getQueryMetadata();
    
    /**
     * Returns whether or not a query's mapping root is valid.  It may be stale. This is to prevent unnecessary validation 
     * @return
     * @since 5.0.2
     */
    boolean isValidRoot();
    
    EObject getTransformationRoot();
    
    void setElementSymbolOptimization(ElementSymbolOptimization status);
    
    /**
     * Returns whether or not a transformation target should be validated
     * 
     *  - User Defined Functions (virtual procedures where procedure.isFunction() == TRUE
     *  
     *  @return
     */
    boolean shouldValidate();
}