src/include/common/filter/WhereClause.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_WHERECLAUSE
00037 #define INCL_WHERECLAUSE
00038 
00040 #include "base/fscapi.h"
00041 #include "filter/Clause.h"
00042 
00043 typedef enum {
00044     EQ       =  0,
00045     NE       =  1,
00046     GT       =  2,
00047     LT       =  3,
00048     GE       =  4,
00049     LE       =  5,
00050     CONTAIN  =  6,
00051     NCONTAIN =  7,
00052     UNKNOWN  = -1
00053 } WhereClauseOperator;
00054 
00055 class WhereClause : public Clause {
00056 
00057     // ------------------------------------------------------- Private interface
00058 private:
00059 
00060     char*             property     ;
00061     char*             value        ;
00062     WhereClauseOperator op           ;
00063     BOOL                caseSensitive;
00064 
00065     // ----------------------------------------------------- Protected interface
00066 protected:
00067 
00068     // -------------------------------------------------------- Public interface
00069 public:
00070 
00071     /*
00072      * WhereClause constructor
00073      *
00074      */
00075     WhereClause();
00076 
00077 
00078     /*
00079      * WhereClause constructor
00080      *
00081      * @param property
00082      * @param value
00083      * @param o
00084      * @param s
00085      */
00086     WhereClause(const char*  property, const char*  value, WhereClauseOperator o, BOOL p3);
00087 
00088 
00089     /*
00090      * WhereClause destructor
00091      *
00092      */
00093     ~WhereClause();
00094 
00095     /*
00096      * setProperty
00097      *
00098      * @param p0
00099      */
00100     void setProperty(const char* p);
00101 
00102 
00103     /*
00104      * getProperty
00105      *
00106      */
00107     const char* getProperty();
00108 
00109 
00110 
00111     /*
00112      * setValue
00113      *
00114      * @param p0
00115      */
00116     void setValue(const char* v);
00117 
00118 
00119     /*
00120      * getvalue
00121      *
00122      */
00123     const char* getValue();
00124 
00125 
00126     /*
00127      * getOperator
00128      *
00129      */
00130     WhereClauseOperator getOperator();
00131 
00132 
00133     /*
00134      * setOperator
00135      *
00136      * @param o
00137      */
00138     void setOperator(WhereClauseOperator o);
00139 
00140 
00141     /*
00142      * isCaseSensitive
00143      *
00144      */
00145     BOOL isCaseSensitive();
00146 
00147 
00148     /*
00149      * setCaseSensitive
00150      *
00151      * @param s
00152      */
00153     void setCaseSensitive(BOOL s);
00154 
00155     /*
00156      * Creates a new instance of this Clause
00157      *
00158      * @return the clone
00159      */
00160     ArrayElement* clone();
00161 
00162 
00163 };
00164 
00165 
00167 #endif

Generated on Thu Mar 6 14:25:04 2008 for Funambol C++ Client Library by  doxygen 1.5.2