connectivity/source/inc/file/FDateFunctions.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
  20 #pragma once
  21
  22 #include <file/fcode.hxx>
  23
  24 namespace connectivity::file
  25     {
  26         /** DAYOFWEEK(date)
  27             Returns the weekday index for date (1 = Sunday, 2 = Monday, ... 7 = Saturday). These index values correspond to the ODBC standard.
  28
  29         > SELECT DAYOFWEEK('1998-02-03');
  30                 -> 3
  31         */
  32         class OOp_DayOfWeek : public OUnaryOperator
  33         {
  34         protected:
  35             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
  36         };
  37
  38         /** DAYOFMONTH(date)
  39             Returns the day of the month for date, in the range 1 to 31:
  40
  41         > SELECT DAYOFMONTH('1998-02-03');
  42                 -> 3
  43         */
  44         class OOp_DayOfMonth : public OUnaryOperator
  45         {
  46         protected:
  47             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
  48         };
  49
  50         /** DAYOFYEAR(date)
  51             Returns the day of the year for date, in the range 1 to 366:
  52
  53         > SELECT DAYOFYEAR('1998-02-03');
  54                 -> 34
  55
  56         */
  57         class OOp_DayOfYear : public OUnaryOperator
  58         {
  59         protected:
  60             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
  61         };
  62
  63         /** MONTH(date)
  64             Returns the month for date, in the range 1 to 12:
  65
  66         > SELECT MONTH('1998-02-03');
  67                 -> 2
  68         */
  69         class OOp_Month : public OUnaryOperator
  70         {
  71         protected:
  72             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
  73         };
  74
  75         /** DAYNAME(date)
  76             Returns the name of the weekday for date:
  77
  78         > SELECT DAYNAME('1998-02-05');
  79                 -> 'Thursday'
  80
  81         */
  82         class OOp_DayName : public OUnaryOperator
  83         {
  84         protected:
  85             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
  86         };
  87
  88         /** MONTHNAME(date)
  89             Returns the name of the month for date:
  90
  91         > SELECT MONTHNAME('1998-02-05');
  92                 -> 'February'
  93
  94         */
  95         class OOp_MonthName : public OUnaryOperator
  96         {
  97         protected:
  98             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
  99         };
 100
 101         /** QUARTER(date)
 102             Returns the quarter of the year for date, in the range 1 to 4:
 103
 104         > SELECT QUARTER('98-04-01');
 105                 -> 2
 106
 107         */
 108         class OOp_Quarter : public OUnaryOperator
 109         {
 110         protected:
 111             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
 112         };
 113
 114         /** WEEK(date)
 115             WEEK(date,first)
 116                 With a single argument, returns the week for date, in the range 0 to 53 (yes, there may be the beginnings of a week 53), for locations where Sunday is the first day of the week. The two-argument form of WEEK() allows you to specify whether the week starts on Sunday or Monday and whether the return value should be in the range 0-53 or 1-52. Here is a table for how the second argument works:
 117                 Value   Meaning
 118                 0   Week starts on Sunday and return value is in range 0-53
 119                 1   Week starts on Monday and return value is in range 0-53
 120                 2   Week starts on Sunday and return value is in range 1-53
 121                 3   Week starts on Monday and return value is in range 1-53 (ISO 8601)
 122
 123             > SELECT WEEK('1998-02-20');
 124                     -> 7
 125             > SELECT WEEK('1998-02-20',0);
 126                     -> 7
 127             > SELECT WEEK('1998-02-20',1);
 128                     -> 8
 129             > SELECT WEEK('1998-12-31',1);
 130                     -> 53
 131
 132         */
 133         class OOp_Week : public ONthOperator
 134         {
 135         protected:
 136             virtual ORowSetValue operate(const std::vector<ORowSetValue>& lhs) const override;
 137         };
 138
 139         /** YEAR(date)
 140             Returns the year for date, in the range 1000 to 9999:
 141
 142         > SELECT YEAR('98-02-03');
 143                 -> 1998
 144         */
 145         class OOp_Year : public OUnaryOperator
 146         {
 147         protected:
 148             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
 149         };
 150
 151         /** HOUR(time)
 152             Returns the hour for time, in the range 0 to 23:
 153
 154         > SELECT HOUR('10:05:03');
 155                 -> 10
 156         */
 157         class OOp_Hour : public OUnaryOperator
 158         {
 159         protected:
 160             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
 161         };
 162
 163         /** MINUTE(time)
 164             Returns the minute for time, in the range 0 to 59:
 165
 166         > SELECT MINUTE('98-02-03 10:05:03');
 167                 -> 5
 168
 169         */
 170         class OOp_Minute : public OUnaryOperator
 171         {
 172         protected:
 173             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
 174         };
 175
 176         /** SECOND(time)
 177             Returns the second for time, in the range 0 to 59:
 178
 179         > SELECT SECOND('10:05:03');
 180                 -> 3
 181         */
 182         class OOp_Second : public OUnaryOperator
 183         {
 184         protected:
 185             virtual ORowSetValue operate(const ORowSetValue& lhs) const override;
 186         };
 187
 188         /** CURDATE()
 189             CURRENT_DATE
 190                 Returns today's date as a value in 'YYYY-MM-DD' or YYYYMMDD format, depending on whether the function is used in a string or numeric context:
 191
 192             > SELECT CURDATE();
 193                     -> '1997-12-15'
 194         */
 195         class OOp_CurDate : public ONthOperator
 196         {
 197         protected:
 198             virtual ORowSetValue operate(const std::vector<ORowSetValue>& lhs) const override;
 199         };
 200
 201         /** CURTIME()
 202             CURRENT_TIME
 203                 Returns the current time as a value in 'HH:MM:SS' or HHMMSS format, depending on whether the function is used in a string or numeric context:
 204
 205             > SELECT CURTIME();
 206                     -> '23:50:26'
 207         */
 208         class OOp_CurTime : public ONthOperator
 209         {
 210         protected:
 211             virtual ORowSetValue operate(const std::vector<ORowSetValue>& lhs) const override;
 212         };
 213
 214         /** NOW()
 215             Returns the current date and time as a value in 'YYYY-MM-DD HH:MM:SS' or YYYYMMDDHHMMSS format, depending on whether the function is used in a string or numeric context:
 216
 217             > SELECT NOW();
 218                     -> '1997-12-15 23:50:26'
 219         */
 220         class OOp_Now : public ONthOperator
 221         {
 222         protected:
 223             virtual ORowSetValue operate(const std::vector<ORowSetValue>& lhs) const override;
 224         };
 225
 226 }
 227
 228 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */