include/Field.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *    Copyright (C) Lakshya Solutions Ltd. All rights reserved.            *
   4  *                                                                         *
   5  ***************************************************************************/
   6
   7 #ifndef FIELD_H
   8 #define FIELD_H
   9 #include<os.h>
  10 #include<DataType.h>
  11 #include<ErrorType.h>
  12
  13 //used by FieldNameList
  14 class FieldNameNode
  15 {
  16     public:
  17     char  fldName[IDENTIFIER_LENGTH];
  18     FieldNameNode *next;
  19 };
  20
  21
  22 class FieldDef
  23 {
  24     public:
  25     FieldDef()
  26     {
  27         init();
  28     }
  29     void init() {
  30         type_ = typeUnknown;
  31         length_ = 0;
  32         offset_ = 0;
  33         bindVal_ = NULL;
  34         isDefault_ = false;
  35         isNull_ = false;
  36         isPrimary_ = false;
  37         isUnique_ = false;
  38         isAutoIncrement_=false;
  39         isNullExplicit_ = false;
  40         strcpy(fldName_, "");
  41     }
  42     char fldName_[IDENTIFIER_LENGTH];
  43     DataType type_;
  44     size_t length_;
  45     size_t offset_;
  46     //currently default value is supported for string and binary
  47     //less than length 32 bytes
  48     char defaultValueBuf_[DEFAULT_VALUE_BUF_LENGTH];
  49
  50     //used only in case of binding fields
  51     void *bindVal_;
  52
  53     bool isNull_;
  54     bool isPrimary_;
  55     bool isDefault_;
  56     bool isUnique_;
  57     bool isAutoIncrement_;
  58     bool isNullExplicit_; // if null is specified on default value field.
  59     long long autoVal_;//[DEFAULT_VALUE_BUF_LENGTH];
  60     //TODO::width and scale
  61 };
  62
  63 class FieldNode
  64 {
  65     public:
  66     FieldDef fldDef;
  67     FieldNode *next;
  68 };
  69
  70
  71 class FieldIterator
  72 {
  73     public:
  74     FieldNode *iter;
  75     FieldIterator(FieldNode *ptr) { iter = ptr; }
  76     bool hasElement()
  77     {
  78         if (iter == NULL) return false; else return true;
  79     }
  80     FieldDef* nextElement()
  81     {
  82         if (iter == NULL) { return NULL;}
  83         FieldNode *node = iter;
  84         iter = iter ->next;
  85         return &(node->fldDef);
  86     }
  87 };
  88
  89 class FieldInfo;
  90
  91 //Internal class used to implement the field list information
  92 //to create the table
  93 class DllExport FieldList
  94 {
  95     public:
  96     FieldNode *head;
  97     FieldList(){ head = NULL;}
  98
  99     //TODO::pass by reference instead of value
 100     DbRetVal append(FieldDef fDef);
 101
 102     DbRetVal remove(const char* fldName);
 103
 104     DbRetVal removeAll();
 105
 106     DbRetVal updateBindVal(const char *fldName, void *val, bool isNllEx=false);
 107     void * getBindField(const char *fldName);
 108     int getFieldOffset(const char *fldName);
 109     int getFieldOffset(int fldpos);
 110
 111     //Returns position of field in the list:count starting from 1
 112     int getFieldPosition(const char *fldName);
 113
 114     DataType getFieldType(const char *fldName);
 115
 116     size_t getFieldLength(const char *fldName);
 117
 118     DbRetVal getFieldInfo(const char *fldName, FieldInfo *&info);
 119     void fillFieldInfo(int fldpos, void *info);
 120     int size();
 121     int getTupleSize();
 122
 123     FieldIterator getIterator()
 124     {
 125         FieldIterator iter(head);
 126         return iter;
 127     }
 128 };
 129
 130 //The below struct should be same as Parser.h:FieldValue
 131 //For performance reason and it is
 132 //done such that storage does not have dependency on SQL
 133 struct FieldInfoValue
 134 {
 135     char fldName[IDENTIFIER_LENGTH];
 136     char *parsedString;
 137     void *value;
 138     int paramNo; // 0 ->not a param. It stores the param position
 139     DataType type;
 140     int aType; //assumes enum is always int
 141     int length;
 142     bool isNullable;
 143     bool isAllocVal;
 144     bool isInResSet;
 145
 146     size_t offset;
 147     bool isPrimary;
 148     bool isUnique;
 149     bool isAutoIncrement;
 150 };
 151
 152 #endif