rdbModel::Assertion Class Reference

#include <Assertion.h>

Classes
class	Operator

Public Member Functions
	Assertion (Operator *op=0, Table *myTable=0, bool keepOp=false)
	Assertion (const Assertion *orig, Row *toBe)
	~Assertion ()
Visitor::VisitorState	accept (Visitor *v)
Operator *	getOperator () const
const std::string &	getPrecompiled () const
bool	getToBe () const
bool	getOld () const
const std::string &	getName () const
void	setName (const std::string &name)
bool	verify (Row &old, Row &toBe) const

Detailed Description

Assertions are used in at least two ways:

1. As part of a table description. The assertion describes a condition which should be evaluated upon a particular event, such as when a new element is to be inserted. Such assertions stick around for the life of the application instance. If the assertion is checked often, a pre-compiled version (dependent on the type of connection) can save some time.
   
2. As a WHERE clause in a client-institued UPDATE or SELECT. These are only around long enough to do the UPDATE or SELECT.

The bulk of the information comprising an assertion is kept in a tree whose nodes are "operations". An operation may be either a comparison ( =, <=, etc. and also "is null") or an operation which has child operations: OR, AND, NOT, for all, there exists, hence a node is a leaf node iff it's a comparison.

Once an operation has been incorporated into an Assertion or into another operation, it is 'owned' by this parent. Deleting the parent will cause its children to be deleted. Hence applications building assertions out of operators should never delete those operators.

Definition at line 56 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

Constructor & Destructor Documentation

Assertion() [1/2]

rdbModel::Assertion::Assertion ( Operator *  op = 0, Table *  myTable = 0, bool  keepOp = false  )

inline

Normally, operator associated with the assertion will be deleted when the assertion itself is deleted, but this won't happen if keepOp is set to true.

Definition at line 180 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

                                                                     : 
      m_op(op), m_myTable(myTable), m_keepOp(keepOp)
    { m_compiled.clear(); m_name.clear();};

Assertion() [2/2]

rdbModel::Assertion::Assertion	(	const Assertion *	orig,
		Row *	toBe
	)

Copy original assertion, but, wherever a colRef is a "toBe", substitute with value from toBe row. toBe is not const because we may need to sort it.

Definition at line 23 of file Calibration/rdbModel/rdbModel-00-01-01/src/Tables/Assertion.cxx.

    : m_op(0), m_myTable(orig->m_myTable), m_keepOp(false), m_name(""),
      m_compiled("") {
    toBe->rowSort();
    m_op = new Assertion::Operator(orig->m_op, toBe);
 
  }

~Assertion()

rdbModel::Assertion::~Assertion

(

)

Definition at line 31 of file Calibration/rdbModel/rdbModel-00-01-01/src/Tables/Assertion.cxx.

                        {
    if (!m_keepOp) delete m_op;
  }

Member Function Documentation

accept()

Visitor::VisitorState rdbModel::Assertion::accept

(

Visitor *

v

)

Definition at line 344 of file Calibration/rdbModel/rdbModel-00-01-01/src/Tables/Assertion.cxx.

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

getName()

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

inline

Definition at line 207 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

{return m_name;}

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

getOld()

bool rdbModel::Assertion::getOld ( ) const

inline

Returns true if associated operator or descendant refers to existing row

Definition at line 205 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

{return m_op->getOld();}

Referenced by verify().

getOperator()

Operator * rdbModel::Assertion::getOperator ( ) const

inline

Definition at line 195 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

{return m_op;}

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

getPrecompiled()

const std::string & rdbModel::Assertion::getPrecompiled ( ) const

inline

Definition at line 197 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

{return m_compiled;}

getToBe()

bool rdbModel::Assertion::getToBe ( ) const

inline

True if associated operator or descendant refers to future row (in which case can't call MySql::compileAssertion)

Definition at line 201 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

{return m_op->getToBe();}

Referenced by verify().

setName()

void rdbModel::Assertion::setName ( const std::string &  name )

inline

Definition at line 208 of file Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h.

{m_name = name;}

verify()

bool rdbModel::Assertion::verify	(	Row &	old,
		Row &	toBe
	)		const

verify checks if assertion (which may refer to one or both of an old row and a proposed row) holds for these arguments.
Caller is responsible for fetching old row fields out of dbs if necessary May throw RdbException

Definition at line 350 of file Calibration/rdbModel/rdbModel-00-01-01/src/Tables/Assertion.cxx.

                                                   {
 
    if (getOld() ) { // will actually use old vector, so sort
      old.rowSort();
    }
    if (getToBe() ) { // will actually use toBe vector, so sort
      toBe.rowSort();
    }
    return m_op->verify(old, toBe, m_myTable);
  }

Referenced by rdbModel::Table::insertLatest(), rdbModel::Table::insertRow(), main(), and rdbModel::Assertion::Operator::verify().

---

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

• Calibration/rdbModel/rdbModel-00-01-01/rdbModel/Tables/Assertion.h
• Calibration/rdbModel/rdbModel-00-01-01/src/Tables/Assertion.cxx