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 #include "base/globalsdef.h"
00043 
00044 BEGIN_NAMESPACE
00045 
00046 typedef enum {
00047     EQ       =  0,
00048     NE       =  1,
00049     GT       =  2,
00050     LT       =  3,
00051     GE       =  4,
00052     LE       =  5,
00053     CONTAIN  =  6,
00054     NCONTAIN =  7,
00055     UNKNOWN  = -1
00056 } WhereClauseOperator;
00057 
00058 class WhereClause : public Clause {
00059 
00060     // ------------------------------------------------------- Private interface
00061 private:
00062 
00063     char*             property     ;
00064     char*             value        ;
00065     WhereClauseOperator op           ;
00066     bool                caseSensitive;
00067 
00068     // ----------------------------------------------------- Protected interface
00069 protected:
00070 
00071     // -------------------------------------------------------- Public interface
00072 public:
00073 
00074     /*
00075      * WhereClause constructor
00076      *
00077      */
00078     WhereClause();
00079 
00080 
00081     /*
00082      * WhereClause constructor
00083      *
00084      * @param property
00085      * @param value
00086      * @param o
00087      * @param s
00088      */
00089     WhereClause(const char*  property, const char*  value, WhereClauseOperator o, bool p3);
00090 
00091 
00092     /*
00093      * WhereClause destructor
00094      *
00095      */
00096     ~WhereClause();
00097 
00098     /*
00099      * setProperty
00100      *
00101      * @param p0
00102      */
00103     void setProperty(const char* p);
00104 
00105 
00106     /*
00107      * getProperty
00108      *
00109      */
00110     const char* getProperty();
00111 
00112 
00113 
00114     /*
00115      * setValue
00116      *
00117      * @param p0
00118      */
00119     void setValue(const char* v);
00120 
00121 
00122     /*
00123      * getvalue
00124      *
00125      */
00126     const char* getValue();
00127 
00128 
00129     /*
00130      * getOperator
00131      *
00132      */
00133     WhereClauseOperator getOperator();
00134 
00135 
00136     /*
00137      * setOperator
00138      *
00139      * @param o
00140      */
00141     void setOperator(WhereClauseOperator o);
00142 
00143 
00144     /*
00145      * isCaseSensitive
00146      *
00147      */
00148     bool isCaseSensitive();
00149 
00150 
00151     /*
00152      * setCaseSensitive
00153      *
00154      * @param s
00155      */
00156     void setCaseSensitive(bool s);
00157 
00158     /*
00159      * Creates a new instance of this Clause
00160      *
00161      * @return the clone
00162      */
00163     ArrayElement* clone();
00164 
00165 
00166 };
00167 
00168 
00169 
00170 END_NAMESPACE
00171 
00173 #endif

Generated on Wed Jan 14 17:15:36 2009 for Funambol C++ Client Library by  doxygen 1.5.2