connectivity/source/inc/hsqldb/HTools.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: HTools.hxx,v $
  10  * $Revision: 1.3 $
  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_HTOOLS_HXX
  32 #define CONNECTIVITY_HTOOLS_HXX
  33
  34 /** === begin UNO includes === **/
  35 /** === end UNO includes === **/
  36
  37 #include <rtl/ustrbuf.hxx>
  38
  39 //........................................................................
  40 namespace connectivity { namespace hsqldb
  41 {
  42 //........................................................................
  43
  44     //====================================================================
  45     //= HTools
  46     //====================================================================
  47     class HTools
  48     {
  49     public:
  50         /** appens a proper WHERE clause to the given buffer, which filters
  51             for a given table name
  52
  53             @param _bShortForm
  54                 <TRUE/> if the column names of the system table which is being asked
  55                 have the short form (TABLE_CAT instead of TABLE_CATALOG, and so on)
  56         */
  57         static void appendTableFilterCrit(
  58             ::rtl::OUStringBuffer& _inout_rBuffer, const ::rtl::OUString& _rCatalog,
  59             const ::rtl::OUString _rSchema, const ::rtl::OUString _rName,
  60             bool _bShortForm
  61         );
  62     };
  63
  64 //........................................................................
  65 } } // namespace connectivity::hsqldb
  66 //........................................................................
  67
  68 #endif // CONNECTIVITY_HTOOLS_HXX