connectivity/source/drivers/evoab/LColumnAlias.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LColumnAlias.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _CONNECTIVITY_EVOAB_LCOLUMNALIAS_HXX_
  32 #define _CONNECTIVITY_EVOAB_LCOLUMNALIAS_HXX_
  33
  34 #include <unotools/confignode.hxx>
  35
  36 #include <osl/mutex.hxx>
  37 #include <vector>
  38 #include <map>
  39
  40 namespace connectivity
  41 {
  42     namespace evoab
  43     {
  44         typedef enum {
  45             FIRSTNAME = 0,
  46             LASTNAME,
  47             DISPLAYNAME,
  48             NICKNAME,
  49             PRIMARYEMAIL,
  50             SECONDEMAIL,
  51             PREFERMAILFORMAT,
  52             WORKPHONE,
  53             HOMEPHONE,
  54             FAXNUMBER,
  55             PAGERNUMBER,
  56             CELLULARNUMBER,
  57             HOMEADDRESS,
  58             HOMEADDRESS2,
  59             HOMECITY,
  60             HOMESTATE,
  61             HOMEZIPCODE,
  62             HOMECOUNTRY,
  63             WORKADDRESS,
  64             WORKADDRESS2,
  65             WORKCITY,
  66             WORKSTATE,
  67             WORKZIPCODE,
  68             WORKCOUNTRY,
  69             JOBTITLE,
  70             DEPARTMENT,
  71             COMPANY,
  72             WEBPAGE1,
  73             WEBPAGE2,
  74             BIRTHYEAR,
  75             BIRTHMONTH,
  76             BIRTHDAY,
  77             NOTES,
  78             END
  79         } ProgrammaticName;
  80
  81         class OColumnAlias
  82         {
  83             /**
  84              * m_Alias holds aliases for the evolution addressbook
  85               * column names. This member gets initialised during
  86                          * creation of the connection to the driver.
  87              * m_aAlias initialises m_aAliasMap which then can be
  88                  * used to find the corresponding programmatic name
  89              * when an alias is used as a query attribute. Mozilla
  90              * expects programmatic names from its clients.
  91                *
  92              * m_aAlias:   vector of aliases used to initialise m_aAliasMap.
  93              * m_AliasMap: map of {alias, programmaticname} pairs.
  94              *
  95              */
  96             private:
  97                 ::std::vector< ::rtl::OUString> m_aAlias;
  98                 ::std::vector< ::rtl::OUString> m_aHeadLineNames;
  99                 ::std::map< ::rtl::OUString, ::rtl::OUString> m_aAliasMap;
 100             protected:
 101                 ::osl::Mutex  m_aMutex;
 102             public:
 103                 void initialise(void);
 104                 const ::std::vector< ::rtl::OUString> & getAlias(void) const;
 105                 const ::std::map< ::rtl::OUString, ::rtl::OUString> & getAliasMap(void) const;
 106                 void setAlias(const ::com::sun::star::uno::Reference<
 107                                                     ::com::sun::star::lang::XMultiServiceFactory > &);
 108             private:
 109                 void setAliasMap(void);
 110             public:
 111                 OColumnAlias(void);
 112                 ~OColumnAlias(void);
 113         };
 114     }
 115 }
 116 #endif // _CONNECTIVITY_EVOAB_LCOLUMNALIAS_HXX_