QCocCommenceDataSet Class Reference

DumontDataSet Server Interface Implementation. More...

#include <QCoCommenceDataSet.h>

Inheritance diagram for QCocCommenceDataSet:

Inheritance graph

List of all members.

Public Member Functions

 QCocCommenceDataSet (QString v_catName, QObject *v_parent=NULL)
virtual ~QCocCommenceDataSet ()
virtual QCocCommenceDBcmcDB (void)
virtual QCocCommenceConversationcmcCV (void)
virtual QCocCommenceCursorcursor (void)
virtual QCocCommenceRowSetrs (void)
virtual QCocCommenceQueryRowSetqrs (void)
virtual QCocCommenceAddRowSetars (void)
virtual QCocCommenceEditRowSeters (void)
virtual QCocCommenceDeleteRowSetdrs (void)
virtual QString meid (void)
virtual QString catName (void)
virtual void catName (QString v_catName)
virtual long columnCount (void)
virtual long rowCount (void)
virtual long editRowCount (void)
virtual long addRowCount (void)
virtual long rowNumber (void)
virtual long rowNumber (long int v_rowNumber)
virtual long firstRow (void)
virtual long prevRow (void)
virtual long nextRow (void)
virtual long lastRow (void)
virtual bool bof (void)
virtual bool eof (void)
virtual bool isDirtyRow (void)
virtual bool isDirtySet (void)
virtual bool isAdd (void)
virtual void addRows (long int v_addRC)
virtual long int addRows (void)
virtual long deleteRow (void)
virtual long post (long int v_flag=0)
virtual int colNumber (QString v_fieldName)
virtual void addFieldColumn (QString v_colName)
virtual void addConnectedColumn (QString v_conName, QString v_catName, QString v_fieldName)
virtual QString fldVar (QString v_fieldName, QString v_varName)
virtual void fldVar (QString v_fieldName, QString v_varName, QString v_varValue)
virtual void delVar (QString v_fieldName, QString v_varName)
virtual QString fv (QString v_fieldName)
virtual void fv (QString v_fieldName, QString v_fieldValue)
virtual QString cv (int v_colNumber)
virtual void cv (int v_colNumber, QString v_fieldValue)
virtual QString vt (QString v_fieldName)
virtual void vt (QString v_fieldName, QString v_fieldValue)
virtual long int vi (QString v_fieldName)
virtual void vi (QString v_fieldName, long int v_fieldValue)
virtual double vd (QString v_fieldName)
virtual void vd (QString v_fieldName, double v_fieldValue)
virtual void dv (QString v_fieldName)
virtual void filterClear (void)
virtual QString filter (void)
virtual void filter (QString filterLine)
virtual void andFilter (QString filterLine)
virtual void orFilter (QString filterLine)
virtual void sortClear (void)
virtual QString sort (void)
virtual void sort (QString sortLine)
virtual void addSort (QString v_sortLine)
virtual QCocCommenceDataSetopenDataSet (QString v_catName, QString v_conName)
virtual QCocCommenceDataSetChangeopenDataSetChange (QString v_catName, QString v_conName)
virtual
QCocCommenceDataSetCalendar
openDataSetCalendar (QString v_catName, QString v_conName)
void keyField (QString v_fieldName)
 Set the field used to uniquely identify rows.
QString keyField (void)
 Return the field used to uniquely identify rows.
QString keyName (void)
 Return the catnameKey field.
QString cfyName (void)
 Return the catnameCfy field.
QString varName (void)
 Return the catnameVar field.

Protected Member Functions

void reopen (void)
void applyColumns (void)
void applyFilterLine (int v_ln)
void applyFilterLines (void)
void applySortLines (void)

Private Member Functions

QString catFieldName (void)
 Return the category name formatted for FieldVar.

Private Attributes

QPointer< QCocCommenceDBm_cmcDB
QPointer
< QCocCommenceConversation
m_cmcCV
QPointer< QCocCommenceCursorm_cursor
QPointer< QCocCommenceRowSetm_rs
QPointer< QCocCommenceQueryRowSetm_qrs
QPointer< QCocCommenceEditRowSetm_ers
QPointer< QCocCommenceAddRowSetm_ars
QPointer
< QCocCommenceDeleteRowSet
m_drs
QString m_meid
QString m_catName
QString m_keyField
long m_rowNumber
long m_editRC
long m_addRC
bool m_bof
bool m_eof
QStringList m_filter
QString m_filterJoin [7]
QStringList m_sort
QStringList m_colNameCache
QStringList m_colNameDefs
QStringList m_conNameDefs


Detailed Description

DumontDataSet Server Interface Implementation.

This class represents the DumontDataSet server class. This class gets instantiated for every DataSet instance requested. It supports a dual-interface meaning it can be interfaced (gotten to) through the ActiveX API and through the C++ direct interface. This means that each function is effectively implemented twice, once for the ActiveX API and once for the C++ interface. This may seem somewhat redundant, but, we got time, eh?

Definition at line 55 of file QCoCommenceDataSet.h.


Constructor & Destructor Documentation

QCocCommenceDataSet::QCocCommenceDataSet ( QString  v_catName,
QObject *  v_parent = NULL 
)

Definition at line 43 of file QCoCommenceDataSet.cpp.

QCocCommenceDataSet::~QCocCommenceDataSet (  )  [virtual]

Definition at line 89 of file QCoCommenceDataSet.cpp.


Member Function Documentation

void QCocCommenceDataSet::addConnectedColumn ( QString  v_conName,
QString  v_catName,
QString  v_fieldName 
) [virtual]

Definition at line 538 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::addFieldColumn ( QString  v_colName  )  [virtual]

Definition at line 527 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::addRowCount ( void   )  [virtual]

Definition at line 343 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::addRows ( void   )  [virtual]

Definition at line 455 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::addRows ( long int  v_addRC  )  [virtual]

Definition at line 441 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::addSort ( QString  v_sortLine  )  [virtual]

Definition at line 790 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::andFilter ( QString  filterLine  )  [virtual]

Definition at line 741 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::applyColumns ( void   )  [protected]

Definition at line 656 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::applyFilterLine ( int  v_ln  )  [protected]

Definition at line 682 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::applyFilterLines ( void   )  [protected]

Definition at line 694 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::applySortLines ( void   )  [protected]

Definition at line 759 of file QCoCommenceDataSet.cpp.

QCocCommenceAddRowSet * QCocCommenceDataSet::ars ( void   )  [virtual]

Definition at line 217 of file QCoCommenceDataSet.cpp.

bool QCocCommenceDataSet::bof ( void   )  [virtual]

Definition at line 402 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::catFieldName ( void   )  [private]

Return the category name formatted for FieldVar.

This is a support function for the Key/Cfy/Var field functions. When selecting the categoryKey, categoryCfy, categoryVar fields, the category name is reduced to a "known" format consisting of an all-lower-case categoryName followed by "Key" "Cfy" or "Var" depending on which field was requested.

See also:
keyName, cfyName, varName

Definition at line 280 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::catName ( QString  v_catName  )  [virtual]

Definition at line 309 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::catName ( void   )  [virtual]

Definition at line 303 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::cfyName ( void   ) 

Return the catnameCfy field.

Definition at line 291 of file QCoCommenceDataSet.cpp.

QCocCommenceConversation * QCocCommenceDataSet::cmcCV ( void   )  [virtual]

Definition at line 136 of file QCoCommenceDataSet.cpp.

QCocCommenceDB * QCocCommenceDataSet::cmcDB ( void   )  [virtual]

Definition at line 108 of file QCoCommenceDataSet.cpp.

int QCocCommenceDataSet::colNumber ( QString  v_fieldName  )  [virtual]

Fetch the columnNumber of a field from the cursor

This routine returns the indexNumber of a column name within the Cursor or RowSet. It uses an internal cache so that once the column has been looked up through the cmcDB api it doesn't need to look it up again.

Definition at line 505 of file QCoCommenceDataSet.cpp.

long QCocCommenceDataSet::columnCount ( void   )  [virtual]

rowCount is a value derived from the current dataSet state. if the dataSet is in the cursor() state, then the rowCount is pulled from that. If the cursor() is in any one of the edit states (Edit, Query, Delete) then the rowCount is pulled from the appropriate RowSet object. Finally, if addRows is active (more than zero), then the add rows is added to the total row count.

Definition at line 315 of file QCoCommenceDataSet.cpp.

QCocCommenceCursor * QCocCommenceDataSet::cursor ( void   )  [virtual]

Definition at line 176 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::cv ( int  v_colNumber,
QString  v_fieldValue 
) [virtual]

Definition at line 593 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::cv ( int  v_colNumber  )  [virtual]

Definition at line 580 of file QCoCommenceDataSet.cpp.

long QCocCommenceDataSet::deleteRow ( void   )  [virtual]

Definition at line 461 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::delVar ( QString  v_fieldName,
QString  v_varName 
) [virtual]

Definition at line 561 of file QCoCommenceDataSet.cpp.

QCocCommenceDeleteRowSet * QCocCommenceDataSet::drs ( void   )  [virtual]

Definition at line 241 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::dv ( QString  v_fieldName  )  [virtual]

Definition at line 646 of file QCoCommenceDataSet.cpp.

long QCocCommenceDataSet::editRowCount ( void   )  [virtual]

Definition at line 327 of file QCoCommenceDataSet.cpp.

bool QCocCommenceDataSet::eof ( void   )  [virtual]

Definition at line 408 of file QCoCommenceDataSet.cpp.

QCocCommenceEditRowSet * QCocCommenceDataSet::ers ( void   )  [virtual]

Definition at line 229 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::filter ( QString  filterLine  )  [virtual]

Definition at line 733 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::filter ( void   )  [virtual]

Definition at line 728 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::filterClear ( void   )  [virtual]

Definition at line 714 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::firstRow ( void   )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 369 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::fldVar ( QString  v_fieldName,
QString  v_varName,
QString  v_varValue 
) [virtual]

Definition at line 555 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::fldVar ( QString  v_fieldName,
QString  v_varName 
) [virtual]

Definition at line 549 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::fv ( QString  v_fieldName,
QString  v_fieldValue 
) [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 574 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::fv ( QString  v_fieldName  )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 568 of file QCoCommenceDataSet.cpp.

bool QCocCommenceDataSet::isAdd ( void   )  [virtual]

Definition at line 435 of file QCoCommenceDataSet.cpp.

bool QCocCommenceDataSet::isDirtyRow ( void   )  [virtual]

Definition at line 414 of file QCoCommenceDataSet.cpp.

bool QCocCommenceDataSet::isDirtySet ( void   )  [virtual]

Definition at line 424 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::keyField ( void   ) 

Return the field used to uniquely identify rows.

See also:
keyField(QString);

Definition at line 268 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::keyField ( QString  v_fieldName  ) 

Set the field used to uniquely identify rows.

In Commence (or any database for that matter) at least one column must be defined to uniquely identify specific rows. This is generally referred to as the "Key" field. In Commence this can be any field, but it is usually the "Name" field. Commence on its own does not have a reliable method of uniquely identifying rows unless the Category has been defined as "No Duplicates". In some cases, especially phone book categories and calendar categories, having a dataset that does not allow duplicates is usually not viable. Commence does include some methods available through the API to fetch the RowID value for any item, but this same value is not available to the built-in filtering system so the value itself, while interesting, is quite useless in practical applications. Therefore another method must be provided for uniquely identifying rows, and this method usually consists of setting aside a field for the sole task of uniquely identifying rows.

See also:
keyField(void);

Definition at line 274 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::keyName ( void   ) 

Return the catnameKey field.

Definition at line 285 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::lastRow ( void   )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 396 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::meid ( void   )  [virtual]

Definition at line 253 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::nextRow ( void   )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 386 of file QCoCommenceDataSet.cpp.

QCocCommenceDataSet * QCocCommenceDataSet::openDataSet ( QString  v_catName,
QString  v_conName 
) [virtual]

Definition at line 805 of file QCoCommenceDataSet.cpp.

QCocCommenceDataSetCalendar * QCocCommenceDataSet::openDataSetCalendar ( QString  v_catName,
QString  v_conName 
) [virtual]

Definition at line 841 of file QCoCommenceDataSet.cpp.

QCocCommenceDataSetChange * QCocCommenceDataSet::openDataSetChange ( QString  v_catName,
QString  v_conName 
) [virtual]

Definition at line 829 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::orFilter ( QString  filterLine  )  [virtual]

Definition at line 749 of file QCoCommenceDataSet.cpp.

long QCocCommenceDataSet::post ( long int  v_flag = 0  )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 467 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::prevRow ( void   )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 376 of file QCoCommenceDataSet.cpp.

QCocCommenceQueryRowSet * QCocCommenceDataSet::qrs ( void   )  [virtual]

Definition at line 205 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::reopen ( void   )  [protected]

Definition at line 149 of file QCoCommenceDataSet.cpp.

long QCocCommenceDataSet::rowCount ( void   )  [virtual]

Definition at line 321 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::rowNumber ( long int  v_rowNumber  )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 355 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::rowNumber ( void   )  [virtual]

Reimplemented in QCocCommenceDataSetChange, and QCocCommenceDataSetCalendar.

Definition at line 349 of file QCoCommenceDataSet.cpp.

QCocCommenceRowSet * QCocCommenceDataSet::rs ( void   )  [virtual]

Definition at line 186 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::sort ( QString  sortLine  )  [virtual]

Definition at line 783 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::sort ( void   )  [virtual]

Definition at line 777 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::sortClear ( void   )  [virtual]

Definition at line 796 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::varName ( void   ) 

Return the catnameVar field.

Definition at line 297 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::vd ( QString  v_fieldName,
double  v_fieldValue 
) [virtual]

Definition at line 640 of file QCoCommenceDataSet.cpp.

double QCocCommenceDataSet::vd ( QString  v_fieldName  )  [virtual]

Definition at line 634 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::vi ( QString  v_fieldName,
long int  v_fieldValue 
) [virtual]

Definition at line 628 of file QCoCommenceDataSet.cpp.

long int QCocCommenceDataSet::vi ( QString  v_fieldName  )  [virtual]

Definition at line 622 of file QCoCommenceDataSet.cpp.

void QCocCommenceDataSet::vt ( QString  v_fieldName,
QString  v_fieldValue 
) [virtual]

Definition at line 616 of file QCoCommenceDataSet.cpp.

QString QCocCommenceDataSet::vt ( QString  v_fieldName  )  [virtual]

Definition at line 610 of file QCoCommenceDataSet.cpp.


Member Data Documentation

Definition at line 234 of file QCoCommenceDataSet.h.

Definition at line 225 of file QCoCommenceDataSet.h.

Definition at line 235 of file QCoCommenceDataSet.h.

QString QCocCommenceDataSet::m_catName [private]

Definition at line 230 of file QCoCommenceDataSet.h.

Definition at line 220 of file QCoCommenceDataSet.h.

Definition at line 219 of file QCoCommenceDataSet.h.

QStringList QCocCommenceDataSet::m_colNameCache [private]

Definition at line 243 of file QCoCommenceDataSet.h.

QStringList QCocCommenceDataSet::m_colNameDefs [private]

Definition at line 244 of file QCoCommenceDataSet.h.

QStringList QCocCommenceDataSet::m_conNameDefs [private]

Definition at line 245 of file QCoCommenceDataSet.h.

Definition at line 221 of file QCoCommenceDataSet.h.

Definition at line 226 of file QCoCommenceDataSet.h.

Definition at line 233 of file QCoCommenceDataSet.h.

Definition at line 236 of file QCoCommenceDataSet.h.

Definition at line 224 of file QCoCommenceDataSet.h.

QStringList QCocCommenceDataSet::m_filter [private]

Definition at line 237 of file QCoCommenceDataSet.h.

QString QCocCommenceDataSet::m_filterJoin[7] [private]

Definition at line 238 of file QCoCommenceDataSet.h.

Definition at line 231 of file QCoCommenceDataSet.h.

QString QCocCommenceDataSet::m_meid [private]

Definition at line 229 of file QCoCommenceDataSet.h.

Definition at line 223 of file QCoCommenceDataSet.h.

Definition at line 232 of file QCoCommenceDataSet.h.

Definition at line 222 of file QCoCommenceDataSet.h.

QStringList QCocCommenceDataSet::m_sort [private]

Definition at line 239 of file QCoCommenceDataSet.h.


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




~ ~ ~ ~ ~ ~
Source Code without Comments is like a Cranberry Garland
without the berries. Comment your Code!
 
Commence Database User Support Group Forum
http://newsgroup.showoff-db.org/
~ ~ ~ ~ ~ ~
Author: Mark Petryk
Lorimark Solutions, LLC
mark@lorimarksolutions.com