rdbModel::Column Class Reference

#include <Column.h>

Public Types
enum	FROM {   FROMdefault = 1 , FROMautoIncrement , FROMnow , FROMprogram ,   FROMendUser }
enum	CONTENTS {   CONTENTSunspecified = 0 , CONTENTSserviceName = 1 , CONTENTSusername = 2 , CONTENTSinsertTime = 3 ,   CONTENTSupdateTime = 4 }
	Hints to program in case FROM field is FROMprogram. More...

Public Member Functions
	Column (Table *myTable=0)
	~Column ()
const std::string &	getName () const
const std::string &	getComment () const
const std::string &	getDefault () const
const std::string &	getTableName () const
Datatype *	getDatatype () const
Enum *	getEnum () const
bool	okValue (const std::string &val, bool set=true) const
bool	isCompatible (const Column *otherCol) const
	Return true if otherCol and this have compatible datatypes.
bool	nullAllowed () const
	Returns true if column may take on value NULL.
bool	stickyInsert () const
bool	isPrimaryKey () const
bool	isAutoIncrement () const
FROM	getSourceType () const
CONTENTS	getContentsType () const
bool	interpret (const std::string &interpType, std::string &val)
Visitor::VisitorState	accept (Visitor *v)

Friends
class	rdbModel::XercesBuilder

Detailed Description

rdbModel representation of a(n SQL-like) table description

Definition at line 23 of file Column.h.

Member Enumeration Documentation

CONTENTS

enum rdbModel::Column::CONTENTS

Hints to program in case FROM field is FROMprogram.

Enumerator
CONTENTSunspecified
CONTENTSserviceName
CONTENTSusername
CONTENTSinsertTime
CONTENTSupdateTime

Definition at line 39 of file Column.h.

                  {
      CONTENTSunspecified = 0,
      CONTENTSserviceName = 1,
      CONTENTSusername    = 2,
      CONTENTSinsertTime   = 3,
      CONTENTSupdateTime = 4
 
    };

FROM

enum rdbModel::Column::FROM

Source of value. Note timestamp with value current time should be indicated by contents value CONTENTSupdateTime or (if only upon insert) CONTENTS enterTime

Enumerator
FROMdefault
FROMautoIncrement
FROMnow
FROMprogram
FROMendUser

Definition at line 30 of file Column.h.

              {
      FROMdefault = 1,          // enduser can override default, however
      FROMautoIncrement,
      FROMnow,                  // datatype must be timestamp - deprecated
      FROMprogram,
      FROMendUser
    };

Constructor & Destructor Documentation

Column()

rdbModel::Column::Column ( Table *  myTable = 0 )

inline

Definition at line 48 of file Column.h.

                             : m_myTable(myTable), m_type(0), 
                               m_isPrimaryKey(false) {
      m_contents = CONTENTSunspecified;
      m_default = std::string("");};

~Column()

rdbModel::Column::~Column

(

)

Definition at line 11 of file Column.cxx.

                  {
    delete m_type;
  }

Member Function Documentation

accept()

Visitor::VisitorState rdbModel::Column::accept

(

Visitor *

v

)

Definition at line 58 of file Column.cxx.

                                               {
 
    Visitor::VisitorState state = v->visitColumn(this);
    if (state == Visitor::VBRANCHDONE) return Visitor::VCONTINUE;
    return state;
  }

getComment()

const std::string & rdbModel::Column::getComment ( ) const

inline

Definition at line 57 of file Column.h.

{return m_comment;};

getContentsType()

CONTENTS rdbModel::Column::getContentsType ( ) const

inline

Definition at line 89 of file Column.h.

{return m_contents;}

getDatatype()

Datatype * rdbModel::Column::getDatatype ( ) const

inline

Definition at line 63 of file Column.h.

{return m_type;};

Referenced by main(), and rdbModel::MysqlConnection::visitColumn().

getDefault()

const std::string & rdbModel::Column::getDefault ( ) const

inline

Definition at line 59 of file Column.h.

{return m_default;}

getEnum()

Enum * rdbModel::Column::getEnum

(

)

const

Return pointer to Enum object associated with this column (if none, return null pointer).

Definition at line 15 of file Column.cxx.

{return m_type->getEnum();}

getName()

const std::string & rdbModel::Column::getName ( ) const

inline

Definition at line 56 of file Column.h.

{return m_name; };

Referenced by rdbModel::ColCompare::operator()(), tryQuick(), and rdbModel::MysqlConnection::visitColumn().

getSourceType()

FROM rdbModel::Column::getSourceType ( ) const

inline

Definition at line 88 of file Column.h.

{return m_from;}

getTableName()

const std::string & rdbModel::Column::getTableName

(

)

const

Definition at line 17 of file Column.cxx.

                                              {
    return m_myTable->getName();
  }

interpret()

bool rdbModel::Column::interpret	(	const std::string &	interpType,
		std::string &	val
	)

Handle special literal values, depending loosely on column datatype. Most Column objects won't do any interpretation, but, for example, timestamp-like columns may substitute for "NOW" Return true if any substitution was done

Definition at line 41 of file Column.cxx.

                                                                    {
    // Currently only interpretation is for timestamp-like columns.
    // Value of interpType must be "time" and val must be "NOW".
    // In this case, substitute ascii current time
    if (interpType.compare(std::string("time")) != 0) return false;
 
    Datatype::TYPES dtype = m_type->getType();
    if ((dtype != Datatype::TYPEdatetime) && 
        (dtype != Datatype::TYPEtimestamp)) {
      return false;
    }
    if (val.compare(std::string("NOW")) != 0) return false;
 
    val = facilities::Timestamp().getString();
    return true;
  }

Referenced by rdbModel::Table::supersedeRow().

isAutoIncrement()

bool rdbModel::Column::isAutoIncrement

(

)

const

Definition at line 37 of file Column.cxx.

                                     {
    return (m_from == FROMautoIncrement);
  }

Referenced by rdbModel::MysqlConnection::visitColumn().

isCompatible()

bool rdbModel::Column::isCompatible

(

const Column *

otherCol

)

const

Return true if otherCol and this have compatible datatypes.

Definition at line 32 of file Column.cxx.

                                                        {
    return m_type->isCompatible(otherCol->m_type);
  }

Referenced by rdbModel::Assertion::Operator::validCompareOp().

isPrimaryKey()

bool rdbModel::Column::isPrimaryKey ( ) const

inline

Definition at line 84 of file Column.h.

{return m_isPrimaryKey;}

Referenced by main().

nullAllowed()

bool rdbModel::Column::nullAllowed ( ) const

inline

Returns true if column may take on value NULL.

Definition at line 80 of file Column.h.

{ return m_null;}

Referenced by calibUtil::Metadata::checkNulls(), and rdbModel::MysqlConnection::visitColumn().

okValue()

bool rdbModel::Column::okValue	(	const std::string &	val,
		bool	set = true
	)		const

See if supplied value meets constraints of column definition

• val std::string representation of value to be checked
• set true if value is to be written to column; false if just being used, e.g. in "where" clause

Definition at line 21 of file Column.cxx.

                                                           {
    // auto increment and datetime values are established by rdbms
    if (set) {
 
      if ( (m_from == FROMautoIncrement) || 
           (m_from == FROMnow)) return false;
    }
 
    return m_type->okValue(val);
  }

Referenced by calibUtil::Metadata::checkValues(), and rdbModel::Assertion::Operator::validCompareOp().

stickyInsert()

bool rdbModel::Column::stickyInsert ( ) const

inline

Definition at line 82 of file Column.h.

{ return m_stickyInsert;}

Friends And Related Function Documentation

rdbModel::XercesBuilder

friend class rdbModel::XercesBuilder

friend

Definition at line 102 of file Column.h.

---

The documentation for this class was generated from the following files:

• Column.h
• Column.cxx