package org.litesoft.orsup.selection;

import org.litesoft.util.IllegalArgument;

// Copyright Status:
//
// All Software available from LiteSoft.org (including this file) is
// hereby released into the public domain.
//
// It is free!  As in, you may use it freely in both commercial and
// non-commercial applications, bundle it with your software
// distribution, include it on a CD-ROM, list the source code in a book,
// mirror the documentation at your own web site, or use it in any other
// way you see fit.
//
// NO Warranty!
//
// All software is provided "as is".
//
// There is ABSOLUTELY NO WARRANTY OF ANY KIND: not for the design, fitness
// (for a particular purpose), level of errors (or lack thereof), or
// applicability of this software.  The entire risk as to the quality
// and performance of this software is with you.  Should this software
// prove defective, you assume the cost of all necessary servicing, repair
// or correction.
//
// In no event unless required by applicable law or agreed to in writing
// will any party who created or may modify and/or redistribute this
// software, be liable to you for damages, including any general,
// special, incidental or consequential damages arising out of the use or
// inability to use this software (including but not limited to loss of
// data or data being rendered inaccurate or losses sustained by you or
// third parties or a failure of this software to operate with any
// other programs), even if such holder or other party has been advised
// of the possibility of such damages.
//
// NOTE: Should you discover a bug, have a recogmendation for a change, wish
// to submit modifications, or wish to add new classes/functionality,
// please email them to:
//
//        changes44@litesoft.org
//

/**
 * An abstract representation of a SQL <i>WHERE</i> clause that supports a
 * column and two (Left & Right) comparison values.<p>
 *
 * This <b>WhereClause</b> is <a href="WhereClauseNotable.html"><b>NOT</b><i>able</i></a>.<p>
 *
 * This form of <b>WhereClause</b> primarily exists to support BETWEEN.<p>
 *
 * See <a href="WhereClause.html">WhereClause</a><br>
 * See <a href="WhereClauseFactory.html">WhereClauseFactory</a><p>
 *
 * Exceptions: All problems caught when the parameter(s) are checked (as
 * indicated/implied in the @param tags) will generate an IllegalArgumentException,
 * and means the API user has a problem.  If a NullPointerException (or some
 * others, like: ClassCastException or ArrayIndexOutOfBoundsException) is thrown,
 * it means the API developer has a problem.  Any Exception that is explicitly
 * thrown in the API, but unrelated to a parameter, will be listed in the throws
 * clause (and hopefully in the tag @throws).  These may (but probably won't) be
 * checked Exceptions.
 *
 * @author  George Smith
 * @version 1.03 02/07/02 Exception Policy, Use of IllegalArgument class.
 * @version 1.02 11/05/01 Completed? JavaDocs
 * @version 1.0 10/07/01
 */

public abstract class AbstractWhereClauseColumnAndTwoValues extends AbstractWhereClauseColumnReference
{
    private Object zLeftValue;
    private Object zRightValue;

    /**
     * Constructor that associates two (Left & Right) comparison values with
     * a column.<p>
     *
     * Note: Both the type of the Column and the types of the Left & Right
     * values should be comparable.  For the SQL generation, the Left &
     * Right value object's toString() method is used for <i>conversion</i>.<p>
     *
     * @param   pType               the Type (BETWEEN) for this WhereClause.
     * @param   pColumnDefinition   Column Definition (!null).
     * @param   pLeftValue          Left (or 1st) value (!null).
     * @param   pRightValue         Right (or 2nd) value (!null).
     */
    protected AbstractWhereClauseColumnAndTwoValues( int pType ,
                                                     SimpleColumnDefinition pColumnDefinition ,
                                                     Object pLeftValue ,
                                                     Object pRightValue )
    {
        super( pType , pColumnDefinition );

        IllegalArgument.ifNull( "Left (GE) Value" , zLeftValue = pLeftValue);
        IllegalArgument.ifNull( "Right (LE) Value" , zRightValue = pRightValue);
    }

    /**
     * Accessor for the Left (or 1st) comparison value (!null).<p>
     *
     * @return the Left (or 1st) comparison value (!null).
     */
    public final Object getLeftValue()
    {
        return zLeftValue;
    }

    /**
     * Accessor for the Right (or 2nd) comparison value (!null).<p>
     *
     * @return the Right (or 2nd) comparison value (!null).
     */
    public final Object getRightValue()
    {
        return zRightValue;
    }
}