include/connectivity/IParseContext.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_CONNECTIVITY_IPARSECONTEXT_HXX
  20 #define INCLUDED_CONNECTIVITY_IPARSECONTEXT_HXX
  21
  22 namespace connectivity { class OSQLParseNode; }
  23
  24 #include <rtl/ustring.hxx>
  25 #include <com/sun/star/lang/Locale.hpp>
  26 #include <connectivity/dbtoolsdllapi.hxx>
  27
  28 namespace connectivity
  29 {
  30     //==========================================================================
  31     //= IParseContext
  32     //==========================================================================
  33     class IParseContext
  34     {
  35     public:
  36         enum    ErrorCode
  37         {
  38             ERROR_NONE      = 0,
  39             ERROR_GENERAL,                  // "Syntax error in SQL expression"
  40             ERROR_VALUE_NO_LIKE,            // "The value #1 can not be used with LIKE."
  41             ERROR_FIELD_NO_LIKE,            // "LIKE can not be used with this field."
  42             ERROR_INVALID_COMPARE,          // "The entered criterion can not be compared with this field."
  43             ERROR_INVALID_INT_COMPARE,      // "The field can not be compared with a number."
  44             ERROR_INVALID_DATE_COMPARE,     // "The field can not be compared with a date."
  45             ERROR_INVALID_REAL_COMPARE,     // "The field can not be compared with a floating point number."
  46             ERROR_INVALID_TABLE,            // "The database does not contain a table named \"#\"."
  47             ERROR_INVALID_TABLE_OR_QUERY,   // "The database does contain neither a table nor a query named \"#\"."
  48             ERROR_INVALID_COLUMN,           // "The column \"#1\" is unknown in the table \"#2\"."
  49             ERROR_INVALID_TABLE_EXIST,      // "The database already contains a table or view with name \"#\"."
  50             ERROR_INVALID_QUERY_EXIST       // "The database already contains a query with name \"#\".";
  51         };
  52
  53         enum    InternationalKeyCode
  54         {
  55             KEY_NONE = 0,
  56             KEY_LIKE,
  57             KEY_NOT,
  58             KEY_NULL,
  59             KEY_TRUE,
  60             KEY_FALSE,
  61             KEY_IS,
  62             KEY_BETWEEN,
  63             KEY_OR,
  64             KEY_AND,
  65             KEY_AVG,
  66             KEY_COUNT,
  67             KEY_MAX,
  68             KEY_MIN,
  69             KEY_SUM,
  70             KEY_EVERY,
  71             KEY_ANY,
  72             KEY_SOME,
  73             KEY_STDDEV_POP,
  74             KEY_STDDEV_SAMP,
  75             KEY_VAR_SAMP,
  76             KEY_VAR_POP,
  77             KEY_COLLECT,
  78             KEY_FUSION,
  79             KEY_INTERSECTION
  80         };
  81
  82     public:
  83         // retrieves language specific error messages
  84         virtual OUString getErrorMessage(ErrorCode _eCodes) const = 0;
  85
  86         // retrieves language specific keyword strings (only ASCII allowed)
  87         virtual OString getIntlKeywordAscii(InternationalKeyCode _eKey) const = 0;
  88
  89         // finds out, if we have an international keyword (only ASCII allowed)
  90         virtual InternationalKeyCode getIntlKeyCode(const OString& rToken) const = 0;
  91
  92         /** get's a locale instance which should be used when parsing in the context specified by this instance
  93             <p>if this is not overridden by derived classes, it returns the static default locale.</p>
  94         */
  95         virtual ::com::sun::star::lang::Locale getPreferredLocale( ) const = 0;
  96
  97     protected:
  98         ~IParseContext() {}
  99     };
 100 }
 101
 102 #endif // INCLUDED_CONNECTIVITY_IPARSECONTEXT_HXX
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */