/*
 Copyright (c) 2007 - 2008 Eric J. Feminella <eric@ericfeminella.com>
 All rights reserved.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is furnished
 to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 @internal
 */

package com.ericfeminella.air.cairngorm.business
{
    import mx.utils.StringUtil;

    /**
     *
     * <code>SQLStatementHelper</code> is an all static utility class
     * which provides a mechanism for substituting tokens specified in
     * a raw statement with arbitrary values.
     *
     */
    public final class SQLStatementHelper
    {
        /**
         *
         * Provides a mechanism allowing substitution of tokens specified in
         * a SQL statement, with an arbitrary list of parameters
         *
         * @example The following example demonstrates a typical implementation
         * of <code<SQLStatementHelper</code> by which the tokens {0}, {1}, {2}
         * are substituted with the values 'a', 'b', 'c'
         *
         * <listing version="3.0">
         *
         * var source:String    = "INSERT INTO 'foo' VALUES('{0}', '{1}') WHERE name='{2}'";
         * var statement:String = SQLStatementHelper.create( source, "a", "b", "c" );
         *
         * trace( statement );
         * // INSERT INTO 'foo' VALUES('a', 'b') WHERE name='c'
         *
         * </listing>
         *
         * @param  SQL statement from which tokens are to be replaced
         * @param  arbitrary values to replace the statement tokens
         * @return String containing the final SQL statement
         *
         */
        public static function create(statement:String, ...args) : String
        {
            var statement:String = StringUtil.substitute( statement, args );
            return statement;
        }
    }
}