1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2009 Sun Microsystems
8
* Clint Byrum <clint@fewbar.com>
10
* This program is free software; you can redistribute it and/or modify
11
* it under the terms of the GNU General Public License as published by
12
* the Free Software Foundation; version 2 of the License.
14
* This program is distributed in the hope that it will be useful,
15
* but WITHOUT ANY WARRANTY; without even the implied warranty of
16
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
* GNU General Public License for more details.
19
* You should have received a copy of the GNU General Public License
20
* along with this program; if not, write to the Free Software
21
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23
#include <drizzled/item.h>
30
* Stores time interval for date/time manipulation
32
class TemporalInterval
36
TemporalInterval(uint32_t in_year,
42
uint64_t in_second_part,
51
second_part(in_second_part),
68
* Sets whether or not this object specifies a negative interval
69
* @param[in] in_neg true if this is a negative interval, false if not
71
void setNegative(bool in_neg= true)
77
* reverse boolean value of the negative flag
85
* @retval true this is a negative temporal interval
86
* @retval false this is a positive temporal interval
88
bool getNegative() const
94
* Populate this TemporalInterval from a string value
96
* To make code easy, allow interval objects without separators.
98
* @param args argument Item structure
99
* @param int_type type of interval to create
100
* @param str_value String pointer to the input value
101
* @return true if the string would result in a null interval
104
bool initFromItem(Item *args, interval_type int_type, String *str_value);
107
* Adds this interval to a DRIZZLE_LTIME structure
109
* @param[in,out] ltime the interval will be added to ltime directly in the ltime structure
110
* @param[in] int_type the type of interval requested
111
* @retval true date was added and value stored properly
112
* @retval false result of addition is a null value
114
bool addDate(DRIZZLE_TIME *ltime, interval_type int_type);
119
* The maximum number of text elements to extract into a temporal interval
121
static const uint32_t MAX_STRING_ELEMENTS = 5;
124
* Each of these corresponds to an 'interval_type'
126
static const uint32_t NUM_YEAR_MONTH_STRING_ELEMENTS = 2;
127
static const uint32_t NUM_DAY_HOUR_STRING_ELEMENTS = 2;
128
static const uint32_t NUM_DAY_MICROSECOND_STRING_ELEMENTS = 5;
129
static const uint32_t NUM_DAY_MINUTE_STRING_ELEMENTS = 3;
130
static const uint32_t NUM_DAY_SECOND_STRING_ELEMENTS = 4;
131
static const uint32_t NUM_HOUR_MICROSECOND_STRING_ELEMENTS = 4;
132
static const uint32_t NUM_HOUR_MINUTE_STRING_ELEMENTS = 2;
133
static const uint32_t NUM_HOUR_SECOND_STRING_ELEMENTS = 3;
134
static const uint32_t NUM_MINUTE_MICROSECOND_STRING_ELEMENTS = 3;
135
static const uint32_t NUM_MINUTE_SECOND_STRING_ELEMENTS = 2;
136
static const uint32_t NUM_SECOND_MICROSECOND_STRING_ELEMENTS = 2;
140
* Get a array of positive numbers from a string object.
141
* Each number is separated by 1 non digit character
142
* Return error if there is too many numbers.
143
* If there is too few numbers, assume that the numbers are left out
144
* from the high end. This allows one to give:
145
* DAY_TO_SECOND as "D MM:HH:SS", "MM:HH:SS" "HH:SS" or as seconds.
147
* @param[in] length: length of str
148
* @param[in] cs: charset of str
149
* @param[out] values: array of results
150
* @param[out] count: count of elements in result array
151
* @param transform_msec: if value is true we suppose
152
* that the last part of string value is microseconds
153
* and we should transform value to six digit value.
154
* For example, '1.1' -> '1.100000'
156
bool getIntervalFromString(const char *str,
158
const CHARSET_INFO * const cs,
161
bool transform_msec);
169
uint64_t second_part;
174
} /* end namespace drizzled */