swift
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
swift::misc::db::IDatastoreObjectWithIntegerKey Class Reference

Class from which a derived class can inherit datastore-related functions. More...

Inheritance diagram for swift::misc::db::IDatastoreObjectWithIntegerKey:
[legend]

Public Types

enum  ColumnIndex {
  IndexDbIntegerKey = CPropertyIndexRef::GlobalIndexIDatastoreInteger , IndexDbKeyAsString , IndexIsLoadedFromDb , IndexDatabaseIcon ,
  IndexVersion , IndexEndMarker
}
 Property index. More...
 
- Public Types inherited from swift::misc::ITimestampBased
enum  ColumnIndex {
  IndexUtcTimestamp = CPropertyIndexRef::GlobalIndexITimestampBased , IndexUtcTimestampFormattedYmdhms , IndexUtcTimestampFormattedYmdhmsz , IndexUtcTimestampFormattedMdhms ,
  IndexUtcTimestampFormattedMdhmsz , IndexUtcTimestampFormattedDhms , IndexUtcTimestampFormattedHms , IndexUtcTimestampFormattedHm ,
  IndexMSecsSinceEpoch
}
 Properties by index.
 

Public Member Functions

int getDbKey () const
 Get DB key.
 
QString getDbKeyAsString () const
 DB key as string.
 
QJsonValue getDbKeyAsJsonValue () const
 Key as JSON value, or null.
 
QString getDbKeyAsStringInParentheses (const QString &prefix={}) const
 Db key in parentheses, e.g. "(3)".
 
void setDbKey (int key)
 Set the DB key.
 
void setDbKey (const QString &key)
 DB key passed as string.
 
bool hasValidDbKey () const
 Has valid DB key.
 
bool isDbEqual (const IDatastoreObjectWithIntegerKey &other) const
 Same DB key and hence equal.
 
bool isLoadedFromDb () const
 Loaded from DB. More...
 
bool matchesDbKeyState (db::DbKeyStateFilter filter) const
 Matches filter?
 
const CIcontoDatabaseIcon () const
 Database icon if this has valid key, otherwise empty.
 
- Public Member Functions inherited from swift::misc::db::IDatastoreObject
const QString & getVersion () const
 Version info.
 
QVersionNumber getQVersion () const
 Version as QVersion.
 
bool hasVersion () const
 Having a version?s.
 
void setVersion (const QString &version)
 Version info.
 
- Public Member Functions inherited from swift::misc::ITimestampBased
QDateTime getUtcTimestamp () const
 Get timestamp.
 
qint64 getMSecsSinceEpoch () const
 Timestamp as ms value.
 
qint64 getTimeDifferenceMs (qint64 compareTime) const
 Time difference in ms.
 
qint64 getTimeDifferenceAbsMs (qint64 compareTime) const
 Time difference in ms.
 
qint64 getTimeDifferenceToNowMs () const
 Time difference to now.
 
qint64 getTimeDifferenceMs (const ITimestampBased &compare) const
 Time difference in ms.
 
qint64 getAbsTimeDifferenceMs (qint64 compareTime) const
 Time difference in ms.
 
qint64 getAbsTimeDifferenceMs (const ITimestampBased &compare) const
 Time difference in ms.
 
void setTimestampToNull ()
 Set to null.
 
void setMSecsSinceEpoch (qint64 mSecsSinceEpoch)
 Timestamp as ms value.
 
void setByYearMonthDayHourMinute (const QString &yyyyMMddhhmmss)
 Set by value such as "20141003231045".
 
void setUtcTimestamp (const QDateTime &timestamp)
 Set timestamp.
 
bool isNewerThan (const ITimestampBased &otherTimestampObj) const
 Is this newer than other?
 
bool isNewerThan (qint64 mSecsSinceEpoch) const
 Is newer than epoch value?
 
bool isOlderThan (const ITimestampBased &otherTimestampObj) const
 Is this older than other?
 
bool isOlderThan (qint64 mSecsSinceEpoch) const
 Is this older than other?
 
bool isOlderThanNowMinusOffset (int offsetMs) const
 Older than now-offset.
 
bool isSame (const ITimestampBased &otherTimestampObj) const
 Same timestamp.
 
qint64 msecsTo (const ITimestampBased &otherTimestampObj) const
 Time difference.
 
qint64 absMsecsTo (const ITimestampBased &otherTimestampObj) const
 Time difference.
 
qint64 msecsToNow () const
 Milliseconds to now.
 
void setCurrentUtcTime ()
 Set the current time as timestamp.
 
void addMsecs (qint64 ms)
 Add the given number of milliseconds to the timestamp.
 
QString getFormattedUtcTimestampHms () const
 As hh:mm:ss.
 
QString getFormattedUtcTimestampHmsz () const
 As hh:mm:ss.zzz.
 
QString getFormattedUtcTimestampHm () const
 As hh:mm.
 
QString getFormattedUtcTimestampDhms () const
 As dd HH mm ss.
 
QString getFormattedUtcTimestampMdhms () const
 As MM dd HH mm ss.
 
QString getFormattedUtcTimestampMdhmsz () const
 As MM dd HH mm ss.zzz.
 
QString getFormattedUtcTimestampYmdhms () const
 As yyyy MM dd HH mm ss.
 
QString getFormattedUtcTimestampYmdhmsz () const
 As yyyy MM dd HH mm ss.zzz.
 
bool hasValidTimestamp () const
 Valid timestamp?
 

Static Public Member Functions

static int invalidDbKey ()
 Invalid key.
 
static int stringToDbKey (const QString &candidate)
 Convert string to DB key.
 
static const CPropertyIndexkeyIndex ()
 The key index.
 
- Static Public Member Functions inherited from swift::misc::ITimestampBased
static bool isAnyTimestampIndex (int index)
 Any of the timestamp indexes.
 
static bool canHandleIndex (CPropertyIndexRef index)
 Can given index be handled.
 

Protected Member Functions

 IDatastoreObjectWithIntegerKey ()
 Constructor.
 
 IDatastoreObjectWithIntegerKey (int key)
 Constructor.
 
void setKeyVersionTimestampFromDatabaseJson (const QJsonObject &json, const QString &prefix=QString())
 Set key and timestamp values.
 
QVariant propertyByIndex (swift::misc::CPropertyIndexRef index) const
 Property by index. More...
 
void setPropertyByIndex (swift::misc::CPropertyIndexRef index, const QVariant &variant)
 Set property by index. More...
 
int comparePropertyByIndex (CPropertyIndexRef index, const IDatastoreObjectWithIntegerKey &compareValue) const
 Compare for index. More...
 
- Protected Member Functions inherited from swift::misc::db::IDatastoreObject
void setTimestampVersionFromDatabaseJson (const QJsonObject &json, const QString &prefix=QString())
 Set versionn and timestamp values.
 
- Protected Member Functions inherited from swift::misc::ITimestampBased
 ITimestampBased ()
 Constructor.
 
 ITimestampBased (qint64 msSincePoch)
 Constructor.
 
 ITimestampBased (const QDateTime &timestamp)
 Constructor.
 
QVariant propertyByIndex (CPropertyIndexRef index) const
 Property by index. More...
 
void setPropertyByIndex (CPropertyIndexRef index, const QVariant &variant)
 Set property by index. More...
 
int comparePropertyByIndex (CPropertyIndexRef index, const ITimestampBased &compareValue) const
 Compare for index. More...
 
void updateMissingParts (const ITimestampBased &other)
 Update missing parts.
 

Static Protected Member Functions

static bool existsKey (const QJsonObject &json, const QString &prefix=QString())
 Is a key available?
 
static bool canHandleIndex (swift::misc::CPropertyIndexRef index)
 Can given index be handled?
 

Protected Attributes

int m_dbKey = -1
 key
 
- Protected Attributes inherited from swift::misc::db::IDatastoreObject
QString m_version
 version info
 
- Protected Attributes inherited from swift::misc::ITimestampBased
qint64 m_timestampMSecsSinceEpoch = -1
 timestamp value
 

Detailed Description

Class from which a derived class can inherit datastore-related functions.

Definition at line 69 of file datastore.h.

Member Enumeration Documentation

◆ ColumnIndex

Property index.

Enumerator
IndexEndMarker 

keep as last element

Definition at line 73 of file datastore.h.

Member Function Documentation

◆ comparePropertyByIndex()

int swift::misc::db::IDatastoreObjectWithIntegerKey::comparePropertyByIndex ( CPropertyIndexRef  index,
const IDatastoreObjectWithIntegerKey compareValue 
) const
protected

Compare for index.

Definition at line 127 of file datastore.cpp.

◆ isLoadedFromDb()

bool swift::misc::db::IDatastoreObjectWithIntegerKey::isLoadedFromDb ( ) const

Loaded from DB.

Remarks
here not really needed, but added to have similar signature as IDatastoreObjectWithStringKey

Definition at line 49 of file datastore.cpp.

◆ propertyByIndex()

QVariant swift::misc::db::IDatastoreObjectWithIntegerKey::propertyByIndex ( swift::misc::CPropertyIndexRef  index) const
protected

Property by index.

Definition at line 94 of file datastore.cpp.

◆ setPropertyByIndex()

void swift::misc::db::IDatastoreObjectWithIntegerKey::setPropertyByIndex ( swift::misc::CPropertyIndexRef  index,
const QVariant &  variant 
)
protected

Set property by index.

Definition at line 110 of file datastore.cpp.


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