#include <CdbView.hh>
Inheritance diagram for CdbView:
Public Member Functions | |
| const CdbDatabasePtr & | parent () const |
| Return a smart pointer to the parent object. | |
| const char * | name () const |
| Obtain the current name of the view. | |
| const CdbId & | id () const |
| Obtain the current identifier of the view. | |
| virtual BdbTime | minValidity () const=0 |
| Obtain the begin time allowed by the view. | |
| virtual BdbTime | maxValidity () const=0 |
| Obtain the end time allowed by the view. | |
| virtual BdbTime | created () const=0 |
| Obtain the creation time of the view. | |
| virtual std::string | description () const=0 |
| Obtain the view description. | |
| virtual bool | hasDefaultConfig () const=0 |
| Check if the view has "default" configuration. | |
| virtual bool | isLocal () const=0 |
| Get the current status of the view. | |
| virtual bool | isFrozen () const=0 |
| Get the current status of the view. | |
| virtual CdbStatus | getDefault (const BdbTime &theValidityTime, CdbConfigElement &theConfigElement) const=0 |
| Get a "config element" at specified point of validity time from the "default" configuration. | |
| virtual CdbStatus | defaultConfigIterator (CdbItr< CdbConfigElement > &theItr) const=0 |
| Set up an iterator of "default config elements". | |
| virtual CdbStatus | get (const char *theName, const BdbTime &theValidityTime, CdbConfigElement &theConfigElement) const=0 |
| Get a "config element" for a condition at specified point of validity time. | |
| virtual CdbStatus | configIterator (const char *theName, CdbItr< CdbConfigElement > &theItr) const=0 |
| Set up an iterator of "config elements" for a condition. | |
| virtual CdbStateId | currentStateId (const BdbTime &theValidityTime) const=0 |
| Get current value of the state identifier. | |
Static Public Member Functions | |
| CdbStatus | instance (CdbViewPtr &theViewPtr, const char *theViewName=0, const char *theDatabaseName=0, const char *theImplementationName=0, const char *theTechnologyName=0) |
| Static locator for a view object. | |
| CdbStatus | instance (CdbViewPtr &theViewPtr, const CdbId &theViewId, const char *theDatabaseName=0, const char *theImplementationName=0, const char *theTechnologyName=0) |
| Static locator for a view object. | |
Protected Member Functions | |
| CdbView (const CdbDatabasePtr &theDatabasePtr, const char *theName, const CdbId &theId) | |
| CdbView (const CdbView &theView) | |
| The copy constructor. | |
| virtual | ~CdbView () |
| The destructor. | |
| CdbView & | operator= (const CdbView &theView) |
| The assignment operator. | |
Friends | |
| class | CdbCPtrBase< CdbView > |
Note, that this is an abstract class specifying the interface to the view. It also maintains the general status of the view object as it's seen to its clients through the API.
This class also includes the CdbStateControl, CdbFolderLocator CdbHistoryProvider and CdbCloneable interfaces.
Definition at line 41 of file CdbView.hh.
|
||||||||||||||||
|
Initialize the context of the view with specified set of parameters. This will also validate the internal state of the object. Both pointers should not point to 0 objects.
Definition at line 78 of file CdbView.cc. References CdbCPtr< CdbDatabase, CdbAlwaysClosePolicy< CdbDatabase > >::isNull(). |
|
|
The copy constructor. Details... Definition at line 89 of file CdbView.cc. |
|
|
The destructor. Is only available for the derived classes and friends to prevent accidental deletion of objects. Definition at line 95 of file CdbView.cc. |
|
||||||||||||
|
Set up an iterator of "config elements" for a condition. The iterator will retirn valid elements for the interval of validity covered by the view.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Obtain the creation time of the view. This method is supposed to be implemented by the corresponding subclass.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Get current value of the state identifier. The method delivers a value of the identifier calculated in the scope of he view. The only explicit parameter of the method is a point of time in the validity dimension, in which the identifier is requested. The returned identifier will be "invalid" should any problem occures to construct (calculate) the identifier. The method is supposed to be implemented by subclasses.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Set up an iterator of "default config elements".
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Obtain the view description. This method is supposed to be implemented by the corresponding subclass.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
||||||||||||||||
|
Get a "config element" for a condition at specified point of validity time. A full path name (inluding a condition itself) is used to specify the corresponding condition. The method delivers its results through the "config element" comprising the found revision policy and its interval of the validity. Note, that returned policy may prohibit accessing the database for specified period of time.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
||||||||||||
|
Get a "config element" at specified point of validity time from the "default" configuration. This method is similar to the regular get() method except it will use (if any) the so called "default" configuration of the view. Since "default" configuration is an optional feature of the view then it may not exist at a particular view. If this is going to be the case then the method will return CdbStatus::NotFound cimpletiuon status.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Check if the view has "default" configuration. A view may have an optional "default" configuration to be used for conditions not having their private configurations.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Obtain the current identifier of the view. It's an extended identifier of the view in the (potentially) distributed installation.
Definition at line 122 of file CdbView.cc. Referenced by CdbSQLApiView::clone(), CdbRooRoView::clone(), CdbBdbSView::clone(), CdbSQLApiView::currentStateId(), CdbRooRoView::currentStateId(), CdbBdbWView::currentStateId(), CdbBdbSView::currentStateId(), CdbSQLApiView::isLocal(), CdbRooRoView::isLocal(), and CdbBdbSView::isLocal(). |
|
||||||||||||||||||||||||
|
Static locator for a view object. Unlike the previous method, this one uses extended identifier of a view to find the corresponding object.
Definition at line 48 of file CdbView.cc. References CdbStatus::Error, CdbDatabase::instance(), and CdbStatus::Success. |
|
||||||||||||||||||||||||
|
Static locator for a view object. Locates specified view object and returns a smart pointer to the transient object of the current class. This "shortcut" allows to avoid the complicated multi-staged process of the object location, which is useless when the intermediate objects are not needed. The last parameter (a pointer to the top-level Cdb singleton) is optional. If 0 is passed then a default instance is used. Note, that if specified object is not found then a smart pointer is initialized to point to 0.
Definition at line 17 of file CdbView.cc. References CdbStatus::Error, CdbDatabase::instance(), and CdbStatus::Success. Referenced by CdbEnvironment::defaultStateId(), CdbFolder::instance(), and main(). |
|
|
Get the current status of the view. A non-"frozen" view is not stable since its configuration is allowed to be changed by the database administration tools. This kind (non-"frozen") views are used where the views is being in a transition state. Once it's done the view can be turned into the "frozen" state. Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Get the current status of the view. The maijor difference of "local" views from others is that their configuration can be modified locally (if it's not in "frozen" state and the corresponding authorization permits modifications.) Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Obtain the end time allowed by the view. This method is supposed to be implemented by the corresponding subclass.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Obtain the begin time allowed by the view. This method is supposed to be implemented by the corresponding subclass.
Implemented in CdbBdbWView, CdbBdbSView, CdbRooRoView, and CdbSQLApiView. |
|
|
Obtain the current name of the view. This name is garanteed to be non 0 pointer.
Definition at line 116 of file CdbView.cc. Referenced by CdbSQLApiView::clone(), CdbRooRoView::clone(), CdbBdbWView::clone(), CdbBdbSView::clone(), CdbSQLApiView::configIterator(), CdbRooRoView::configIterator(), CdbBdbSView::configIterator(), CdbSQLApiView::folderIterator(), CdbSQLApiView::get(), CdbRooRoView::get(), CdbBdbSView::get(), CdbRooRoView::getDefault(), and CdbBdbSView::getDefault(). |
|
|
The assignment operator. Details... Definition at line 99 of file CdbView.cc. References _myId, _myName, and _myParentPtr. |
|
|
Return a smart pointer to the parent object.
Definition at line 110 of file CdbView.cc. Referenced by CdbSQLApiView::clone(), CdbRooRoView::clone(), CdbBdbWView::clone(), and CdbBdbSView::clone(). |
|
|
Definition at line 46 of file CdbView.hh. |
1.3-rc3