src/include/common/spds/DataTransformer.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 
00047  #ifndef INCL_DATA_TRANSFORMER
00048     #define INCL_DATA_TRANSFORMER
00049 
00051     #include "base/fscapi.h"
00052 
00057     struct TransformationInfo {
00058 
00059         BOOL newReturnedData;
00060         long size;
00061         const char*  username;
00062         const char*  password;
00063         const char*  sourceName;
00064 
00065         TransformationInfo() : newReturnedData(FALSE)
00066                              , size(-1)
00067                              , username(NULL)
00068                              , password(NULL)
00069                              , sourceName(NULL) {}
00070 
00071     };
00072 
00073     class DataTransformer {
00074 
00075     private:
00076 
00077         char*  name;
00078 
00079     public:
00080         /*
00081          * Default constructor-destructor
00082          */
00083         DataTransformer();
00084 
00085         DataTransformer(char*  name);
00086 
00087         virtual ~DataTransformer();
00088 
00089         static DataTransformer* getEncoder(const char* name);
00090         static DataTransformer* getDecoder(const char* name);
00091         static BOOL isSupportedEncoder(char*  name);
00092         static BOOL isSupportedDecoder(char*  name);
00093 
00094         void setName(const char* name);
00095         const char* getName();
00096 
00110         virtual char* transform(char* data, TransformationInfo& info) = 0;
00111 
00112     };
00113 
00115 #endif

Generated on Mon Feb 4 09:50:47 2008 for Funambol Outlook Plug-in Library by  doxygen 1.5.2