/*
 * 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.empire.db.expr.column;

import org.apache.empire.db.DBCommand;
import org.apache.empire.db.DBExpr;

/**
 * DBPreparable
 * This interface indicates that a DBExpr Object wants to perform preparation tasks when added to a DBCommand 
 * @author rainer
 */
public interface DBPreparable
{
    /**
     * Prepares an expression for a query
     * This function is called by DBCommand in order to add values as query parameters
     * instead of being literally included in the sql statement
     * 
     * Please Note: This function is internally called.
     * Do not call yourself!
     *  
     * @param cmd the command to which to add the parameters
     * @param parent the parent expression holding the value
     */
    public abstract void prepareParams(DBCommand cmd, DBExpr parent); 
}
