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 <b>LIKE</b> SQL <i>WHERE</i> clause.<p>
 *
 * This <b>WhereClause</b> is <a href="WhereClauseNotable.html"><b>NOT</b><i>able</i></a>.<p>
 *
 * This form of <b>WhereClause</b> is only used with Strings (both as
 * Columns and comparison values) to determine if the column <i>contains</i>
 * the comparison value.  The form of the <i>contains</i> currently is
 * limited to: CONTAINS, STARTS_WITH, ENDS_WITH.<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 AbstractWhereClauseColumnAndLikeValue extends AbstractWhereClauseColumnReference
{
    private static final Class STRING_CLASS = String.class;

    private String zValue;
    private String zWhat;
    private boolean zPreWild;
    private boolean zPostWild;

    /**
     * Constructor that supports the <b>LIKE</b> SQL <i>WHERE</i> clause.<p>
     *
     * @param   pType               The Type (CONTAINS, STARTS_WITH, or ENDS_WITH) for this WhereClause.
     * @param   pColumnDefinition   Column Definition (Column Type must equal String) (!null).
     * @param   pPreWild            Flag indicating if the <i>contains</i> is flexable at the front.
     * @param   pPostWild           Flag indicating if the <i>contains</i> is flexable at the back.
     * @param   pWhat               Label (for pType) for toString() (!null).
     * @param   pValue              String that is to be used for <i>contains</i> checking (!null).
     */
    protected AbstractWhereClauseColumnAndLikeValue( int pType ,
                                                     SimpleColumnDefinition pColumnDefinition ,
                                                     boolean pPreWild ,
                                                     boolean pPostWild ,
                                                     String pWhat ,
                                                     String pValue )
    {
        super( pType , pColumnDefinition );

        zPreWild = pPreWild;
        zPostWild = pPostWild;

        IllegalArgument.ifNull( "What" , zWhat = pWhat);
        IllegalArgument.ifNull( "Value" , zValue = pValue);

        if ( pColumnDefinition.getColumnType() != STRING_CLASS )
            throw IllegalArgument.exception( "Column Type" , "NOT String" );
    }

    /**
     * Accessor for the value that the column is to be checked against.<p>
     *
     * @return column checked against value.
     */
    public final String getValue()
    {
        return zValue;
    }

    /**
     * Helper method for <b>toString()</b> that provides a more efficient
     * mechanism for the recursive decent of a WhereClause <i>tree</i>.<p>
     *
     * @param   pSB   the StringBuffer to build the WhereClause into.<p>
     *
     * @see WhereClause#toString()
     */
    protected void toStringHelper( StringBuffer pSB )
    {
        toStringColumnReference( pSB );
        pSB.append( isNot() ? " Does NOT " : " " );
        pSB.append( zWhat );
        pSB.append( ' ' );
        WhereClauseColumnSupport.makeStringValue( pSB , getColumnDefinition() , getValue() );
    }

    /**
     * Helper method for <b>toSQL()</b> that provides a more efficient
     * mechanism for the recursive decent of a WhereClause <i>tree</i>.<p>
     *
     * Note: May need to override to get proper result for SQL.<p>
     *
     * @param   pSB   the StringBuffer to build the WhereClause into.<p>
     *
     * @see WhereClause#toSQL()
     */
    protected void toSqlHelper( StringBuffer pSB )
    {
        toSqlColumnReference( pSB );
        pSB.append( isNot() ? " NOT LIKE " : " LIKE " );
        WhereClauseColumnSupport.makeSqlLikeValue( pSB , getValue() , zPreWild , zPostWild );
    }
}