Class CDaModel

class CDaModel : public CBase;

Description

Database application engine.

The class:

• wraps a store database (RDbStoreDatabase) object: a database that stores data using a stream network within a store (a CStreamStore). The class uses the standard database concepts, such as views, rows, indexes, and column sets: see the description of DBMS for more information.

• creates and manages a database application helper object (CDaUserDbDesc), to simplify application access to the database

• creates a SQL parameters object (CDaSqlParams), which holds SQL queries for sorting, filtering, and searching the database

• creates an undo-stack (CDaUndoStack) to allow operations on the database to be undone.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CDaModel - Database application engine.

Members

Defined in CDaModel:

• AlterTable(CDaUserColSet *)Changes the structure of a specified table in the database to the specified colu...
• AtRow()Gets the current row in the view.
• Attach(MDaObserver *)Sets a database application engine observer.
• BuildViewL()Builds a database view asynchronously from the last requested find string.
• BuildViewL(const TDesC &)Builds a database view asynchronously from the specified search string.
• BuildViewSyncL()Builds a database view synchronously from the last requested find string.
• BuildViewSyncL(const TDesC &)Builds a database view synchronously from the specified search string.
• CloseDatabase()Closes the object's store database if one is open.
• CloseView()Closes the open database view and destroys the associated column set.
• ColSet()constGets the column definition set for the view.
• CreateDatabaseL(CDaUserColSet *)Creates a new database with a specified column set.
• CreateDatabaseL(CStreamStore *,CDaUserColSet *)Creates and opens a new database with a specified column set.
• CreateIndex(const TDesC &,CDbKey *)Creates a new index with the specified key.
• CurrentRow()constGets the stored current row variable (settable with CDaModel::SetCurrentRow(TInt...
• Database()Gets the current database.
• DbRecordCount()constGets the stored record count variable (settable with CDaModel::SetDbRecordCountL...
• DbStreamId()constGets the ID of the stream in the store holding the database.
• DefaultIndexName()constGets the default index name.
• DeleteRowL()Deletes the current row.
• EAtRowMoved to the specified row.
• ENotAtRowDid not move to any row.
• ETriedBeforeFirstTried to move before first row.
• ETriedBeyondLastTried to move beyond last row.
• ExternalizeL(RWriteStream &)constExternalises the engine setttings to a stream.
• FirstL()Moves to the first row in the view.
• GetL()Gets the current row data for access using the view's column extractor functions...
• GoToBookmarkL(const TDbBookmark &)! Only one view is active at any one time
• HandleFirstFindL()Called by the SQL statement evaluator on finding the first result.
• HasOpenDatabase()constTests if the object has an open database.
• HasRDbView()constTests if a valid view is set.
• HowManySteps(RDbIncremental &,CDaUserColSet *)Initiates an incremental table alteration operation on a database.
• InternalizeL(RReadStream &)Internalises the engine setttings from a stream.
• IsValid()constTests if a valid position in a valid view is set.
• LastL()Moves to the last row in the view.
• MoveToRowL(TInt)Moves to a specified row in the view.
• NewDatabaseL(CStreamStore &)Creates and opens a new store database for the object.
• NewL()Allocates and constructs a new database application engine.
• NewL(CFileStore &)Allocates and constructs a new database application engine, initialising it from...
• NextL()Moves to the next row in the view.
• Observer()constGets the database observer set through CDaModel::Attach(MDaObserver *).
• OpenDatabaseL(CStreamStore &)Opens an existing store database.
• OpenDatabaseL(RDbStoreDatabase &,CStreamStore &)Opens and returns an existing store database.
• Panic(TInt)Produces a "DaModel" category panic.
• PreviousL()Moves to the previous row in the view.
• PutL()Completes the insertion of a row.
• RecordStatsWin()Gets the database observer set through CDaModel::SetRecordStatsWin(MDaObserver *...
• RowPosState()constGets the result of the last row traversal operation.
• RowPosState(TState)Sets the result of the last row traversal operation.
• RowSetCount()constGets the stored row set count variable (settable with CDaModel::SetRowSetCountL(...
• SetCurrentRow(TInt)Sets the stored current row variable.
• SetDbColNo()Sets the column number fields.
• SetDbRecordCountL()Sets the database record count variable to the number of rows in the current vie...
• SetRecordStatsWin(MDaObserver *)Sets the statistics window database engine observer.
• SetRowSetCountL()Sets the database row set count variable to the number of rows in the current vi...
• SetYesNoArray(const CDesCArray &)Sets the yes/no string array.
• SqlParams()constGets the SQL parameters object.
• TStateRow traversal states.
• TableDef()constGets the column definition set for the database table.
• UndoDeleteRowL()Undoes the last delete operation.
• UndoStack()constGets the object's undo stack.
• UserDbDesc()constGets the object's database application helper object.
• View()Gets the database view.
• View()constGets the database view (const overload).
• ViewHasRows()constTests if the view has any rows (i.e. is not empty).
• YesNoArray()constGets the string array set by CDaModel::SetYesNoArray(const CDesCArray &).
• iDebugWin

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CDaModel* NewL();

Description

Allocates and constructs a new database application engine.

Return value

IMPORT_C static CDaModel* NewL(CFileStore &fileStore);

Description

Allocates and constructs a new database application engine, initialising it from a store holding a store database.

The store database is found in the specified store, and opened.

Parameters

Return value

inline void Attach(MDaObserver *aObserver);

Description

Sets a database application engine observer.

Parameters

IMPORT_C void CloseDatabase();

Description

Closes the object's store database if one is open.

IMPORT_C void NewDatabaseL(CStreamStore &aStore);

Description

Creates and opens a new store database for the object.

The existing user column set is set for the new database.

Parameters

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the engine setttings to a stream.

Parameters

IMPORT_C void InternalizeL(RReadStream &source);

Description

Internalises the engine setttings from a stream.

Parameters

IMPORT_C void OpenDatabaseL(CStreamStore &aStore);

Description

Opens an existing store database.

If a database is already open, it is closed.

Parameters

IMPORT_C void OpenDatabaseL(RDbStoreDatabase &aDatabase, CStreamStore &aStore);

Description

Opens and returns an existing store database.

If a database is already open, it is closed.

Parameters

IMPORT_C void CloseView();

Description

Closes the open database view and destroys the associated column set.

IMPORT_C void FirstL();

Description

Moves to the first row in the view.

IMPORT_C void LastL();

Description

Moves to the last row in the view.

IMPORT_C void NextL();

Description

Moves to the next row in the view.

If the position is already on the last row, it remains there.

IMPORT_C void PreviousL();

Description

Moves to the previous row in the view.

If the position is already on the first row, it remains there.

IMPORT_C void MoveToRowL(TInt aRow);

Description

Moves to a specified row in the view.

If the requested row is greater than the last row, the position is set to the last row. If the requested row in less than the first row, the position is set to the first row.

Parameters

inline TBool IsValid() const;

Description

Tests if a valid position in a valid view is set.

Return value

inline const TPtrC& DefaultIndexName() const;

Description

Gets the default index name.

Return value

inline TInt AtRow();

Description

Gets the current row in the view.

Return value

inline TBool HasRDbView() const;

Description

Tests if a valid view is set.

Return value

inline TBool ViewHasRows() const;

Description

Tests if the view has any rows (i.e. is not empty).

Return value

inline TBool HasOpenDatabase() const;

Description

Tests if the object has an open database.

Return value

inline TInt DbRecordCount() const;

Description

Gets the stored record count variable (settable with CDaModel::SetDbRecordCountL()).

Return value

inline TInt RowSetCount() const;

Description

Gets the stored row set count variable (settable with CDaModel::SetRowSetCountL()).

Return value

inline CDbColSet* ColSet() const;

Description

Gets the column definition set for the view.

Return value

inline CDaUserDbDesc* UserDbDesc() const;

Description

Gets the object's database application helper object.

Return value

inline TInt CurrentRow() const;

Description

Gets the stored current row variable (settable with CDaModel::SetCurrentRow(TInt)).

Return value

inline RDbDatabase& Database();

Description

Gets the current database.

Return value

inline TStreamId DbStreamId() const;

Description

Gets the ID of the stream in the store holding the database.

Return value

inline TState RowPosState() const;

Description

Gets the result of the last row traversal operation.

Return value

inline CDaSqlParams* SqlParams() const;

Description

Gets the SQL parameters object.

Return value

inline CDbColSet* TableDef() const;

Description

Gets the column definition set for the database table.

Return value

inline MDaObserver* RecordStatsWin();

Description

Gets the database observer set through CDaModel::SetRecordStatsWin(MDaObserver *).

Return value

inline RDbView& View();

Description

Gets the database view.

Return value

inline const RDbView& View() const;

Description

Gets the database view (const overload).

Return value

inline MDaObserver* Observer() const;

Description

Gets the database observer set through CDaModel::Attach(MDaObserver *).

Return value

inline const CDaUndoStack& UndoStack() const;

Description

Gets the object's undo stack.

Return value

inline const CDesCArray* YesNoArray() const;

Description

Gets the string array set by CDaModel::SetYesNoArray(const CDesCArray &).

The array is not used by the engine.

Return value

inline void SetDbColNo();

Description

Sets the column number fields.

inline void SetCurrentRow(TInt aCurrentRow);

Description

Sets the stored current row variable.

Parameters

inline void RowPosState(TState aState);

Description

Sets the result of the last row traversal operation.

Parameters

inline void SetDbRecordCountL();

Description

Sets the database record count variable to the number of rows in the current view.

inline void SetRowSetCountL();

Description

Sets the database row set count variable to the number of rows in the current view.

inline void SetRecordStatsWin(MDaObserver *anObserver);

Description

Sets the statistics window database engine observer.

The observer is called for every Put() operation.

Parameters

inline void SetYesNoArray(const CDesCArray &aYesNoArray);

Description

Sets the yes/no string array.

This is not used by the engine.

Parameters

IMPORT_C TInt AlterTable(CDaUserColSet *aNewUserColSet);

Description

Changes the structure of a specified table in the database to the specified column set.

! for now

Parameters

Return value

See also:

• RDbDatabase::AlterTable(const TDesC &,const CDbColSet &)Alters a table synchronously.

IMPORT_C void CreateDatabaseL(CDaUserColSet *aUserColSet);

Description

Creates a new database with a specified column set.

An already open database is closed.

Parameters

IMPORT_C void CreateDatabaseL(CStreamStore *aStore, CDaUserColSet *aUserColSet);

Description

Creates and opens a new database with a specified column set.

Parameters

IMPORT_C TInt CreateIndex(const TDesC &anIndexName, CDbKey *aCDbKey);

Description

Creates a new index with the specified key.

Parameters

Return value

See also:

• RDbDatabase::CreateIndex(const TDesC &,const TDesC &,const CDbKey &)Creates an index synchronously.

IMPORT_C TInt HowManySteps(RDbIncremental &anAlterTable, CDaUserColSet *aNewUserColSet);

Description

Initiates an incremental table alteration operation on a database.

Parameters

Return value

IMPORT_C void BuildViewL(const TDesC &aFindString);

Description

Builds a database view asynchronously from the specified search string.

Parameters

IMPORT_C void BuildViewL();

Description

Builds a database view asynchronously from the last requested find string.

IMPORT_C void BuildViewSyncL();

Description

Builds a database view synchronously from the last requested find string.

IMPORT_C void BuildViewSyncL(const TDesC &aFindString);

Description

Builds a database view synchronously from the specified search string.

Parameters

IMPORT_C void HandleFirstFindL();

Description

Called by the SQL statement evaluator on finding the first result.

IMPORT_C void DeleteRowL();

Description

Deletes the current row.

The delete operation is put on the undo stack.

It then moves to the next (or last) row in the view.

!! -1 if now rows in view

IMPORT_C void UndoDeleteRowL();

Description

Undoes the last delete operation.

inline void GetL();

Description

Gets the current row data for access using the view's column extractor functions.

See also:

• RDbRowSet::GetL()Gets the current row data for access using the column extractor functions. The c...

IMPORT_C void PutL();

Description

Completes the insertion of a row.

See also:

• RDbRowSet::PutL()Completes the update or insertion of a row.

IMPORT_C void UpdateAllViewsL(MDaObserver::TNotification=MDaObserver::EDefaultNotification);

Description

Sends a specified event to the database engine observer.

!late

Parameters

IMPORT_C void GoToBookmarkL(const TDbBookmark &aBookmark);

Description

! Only one view is active at any one time

Moves to the specified database bookmark.

Parameters

IMPORT_C static void Panic(TInt aReason);

Description

Produces a "DaModel" category panic.

Parameters

TState

Description

Row traversal states.

MDaObserver * iDebugWin;

Description