Drizzled Public API Documentation

epoch.h

00001 /* - mode: c++ c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2008 MySQL
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #pragma once
00022 
00023 #include <drizzled/field/str.h>
00024 
00025 namespace drizzled
00026 {
00027 
00028 namespace field
00029 {
00030 
00031 class TableShare;
00032 typedef struct charset_info_st CHARSET_INFO;
00033 
00034 class Epoch :public Field_str {
00035 public:
00036 
00037   typedef Epoch* pointer;
00038 
00039   Epoch(unsigned char *ptr_arg,
00040         unsigned char *null_ptr_arg,
00041         unsigned char null_bit_arg,
00042         enum utype unireg_check_arg,
00043         const char *field_name_arg,
00044         drizzled::TableShare *share);
00045 
00046   Epoch(bool maybe_null_arg,
00047         const char *field_name_arg);
00048 
00049   enum_field_types type() const { return DRIZZLE_TYPE_TIMESTAMP;}
00050   enum ha_base_keytype key_type() const { return HA_KEYTYPE_ULONGLONG; }
00051   enum Item_result cmp_type () const { return INT_RESULT; }
00052 
00053   int store(const char *to,uint32_t length,
00054             const CHARSET_INFO * const charset);
00055   int store(double nr);
00056   int store(int64_t nr, bool unsigned_val);
00057   int store_decimal(const type::Decimal *value);
00058 
00059   int  reset(void) { ptr[0]=ptr[1]=ptr[2]=ptr[3]=ptr[4]=ptr[5]=ptr[6]=ptr[7]=0; return 0; }
00060   double val_real(void) const;
00061   int64_t val_int(void) const;
00062   String *val_str(String*,String *) const;
00063   int cmp(const unsigned char *,const unsigned char *);
00064   void sort_string(unsigned char *buff,uint32_t length);
00065   uint32_t pack_length() const { return 8; }
00066   virtual void sql_type(String &str) const;
00067   virtual bool can_be_compared_as_int64_t() const { return true; }
00068   bool zero_pack() const { return 0; }
00069   virtual void set_time();
00070   virtual void set_default();
00071 
00072   /* Get TIMESTAMP field value as seconds since begging of Unix Epoch */
00073   virtual long get_timestamp(bool *null_value) const;
00074 
00075   virtual bool is_timestamp() const
00076   {
00077     return true;
00078   }
00079 
00080 private:
00081   bool get_date(type::Time &ltime,uint32_t fuzzydate) const;
00082   bool get_time(type::Time &ltime) const;
00083 
00084 public:
00085   virtual timestamp_auto_set_type get_auto_set_type() const;
00086   static size_t max_string_length();
00087 };
00088 
00089 } /* namespace field */
00090 } /* namespace drizzled */
00091 
00092