Db objects: DbToken, DbToken.h, POOLCore/DbToken.h. More...

#include <DbToken.h>

Inheritance diagram for pool::DbToken:

Collaboration diagram for pool::DbToken:

Public Types
enum	{ TOKEN_FULL_KEY = 1<<0, TOKEN_CONT_KEY = 1<<1, TOKEN_ITERATOR = 1<<2 }
	Default token key enumeration. More...

Public Member Functions
	DbToken ()
	Standard constructor. More...

virtual bool	equal (const Token &pTok) const
	Fast token comparison: operator equal. More...

virtual bool	less (const Token &pTok) const
	Fast token comparison: operator less. More...

void	setKey (int which)
	Produce the keys only on demand. More...

void	setKeyEx (int which, const Guid &guid)
	Copy the key. More...

void	setUserKey (int i, const Guid &guid)
	Set a user key. More...

void	setTypeInfo (const DbTypeInfo *t)
	Update type information. More...

const DbTypeInfo *	typeInfo () const
	Access type information. More...

void	setLocal (bool val)
	Set local flag. More...

bool	isLocal () const
	Access local flag. More...

void	addTypeSetting (int val)
	Add type setting. More...

void	removeTypeSetting (int val)
	Add type setting. More...

const Guid &	fullKey () const
	Access to user key identifying full token. More...

const Guid &	contKey () const
	Access to user key #1. More...

const Guid &	userkey (int i) const
	Access to optional user keys #2. More...

bool	operator< (const Token &refToken) const
	Operator < to allow ordering. More...

bool	operator> (const Token &refToken) const
	Operator > to allow ordering. More...

bool	operator== (const Token &refToken) const
	Equality operator. More...

bool	operator!= (const Token &refToken) const
	Equality operator. More...

int	release ()
	Release token: Decrease reference count and eventually delete. More...

int	addRef ()
	Increase reference count. More...

const Guid &	dbID () const
	Access database identifier. More...

Token &	setDb (const Guid &db)
	Set database name. More...

Token &	setDb (const std::string &db)

const std::string &	contID () const
	Access container identifier. More...

Token &	setCont (const std::string &cnt)
	Set container name. More...

const Guid &	classID () const
	Access database identifier. More...

Token &	setClassID (const Guid &cl_id)
	Access database identifier. More...

int	technology () const
	Access technology type. More...

Token &	setTechnology (int t)
	Set technology type. More...

const OID_t &	oid () const
	Access object identifier. More...

OID_t &	oid ()
	Access object identifier. More...

Token &	setOid (const OID_t &oid)
	Set object identifier. More...

int	type () const
	Access token type. More...

Token &	setType (int t)
	Set token type. More...

const std::string &	auxString () const
	Access auxiliary string. More...

Token &	setAuxString (const std::string &auxString)
	Set auxiliary string. More...

virtual const std::string	toString () const
	Retrieve the string representation of the token. More...

virtual const std::string	key () const
	Retrieve token key. More...

Token &	fromString (const std::string &from)
	Build from the string representation of a token. More...

const Token &	set (Token *pToken) const
	Set token information. More...

const Token &	setData (Token *pToken) const
	Set all the data part of the token. More...

Static Public Member Functions
static void	makeKey (const Token *tok, int which, Guid &guid)
	Produce the token keys only on demand for export. More...

static int	numInstances ()
	expose Token instance counter for debugging More...

Private Attributes
Guid	m_keyFull
	Buffer to hold user key identifying full token. More...

Guid	m_contKey
	Buffer to hold user key #1. More...

std::vector< Guid >	m_ukeys
	Optional other user keys. More...

const DbTypeInfo *	m_info
	Database type information cache. More...

bool	m_local
	Flag to indicate if toekn is local or foreign. More...

int	m_refCount
	Reference count. More...

unsigned int	m_technology
	Technology identifier. More...

Guid	m_dbID
	Database identifier. More...

std::string	m_cntID
	Container identifier. More...

Guid	m_classID
	Object global identifier. More...

OID_t	m_oid
	Persistent object identifier. More...

int	m_type
	Token type. More...

std::string	m_auxString
	Auxiliary string. More...

Detailed Description

Db objects: DbToken, DbToken.h, POOLCore/DbToken.h.

Description:

Definition of an optimized token used internally in the Database. This token implementation generates an MD5 checksum over the token information. This should be advantageous for long tokens compared to the horrible full lookup of the string exceeding typically 300 chars.

Author: M.Frank

Version: 1.0

Definition at line 42 of file DbToken.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Default token key enumeration.

Enumerator
TOKEN_FULL_KEY
TOKEN_CONT_KEY
TOKEN_ITERATOR

Definition at line 45 of file DbToken.h.

          {TOKEN_FULL_KEY     = 1<<0, 
           TOKEN_CONT_KEY     = 1<<1,
           TOKEN_ITERATOR     = 1<<2
     };

Constructor & Destructor Documentation

◆ DbToken()

pool::DbToken::DbToken ( )

inline

Standard constructor.

Definition at line 64 of file DbToken.h.

64 : m_info(0), m_local(false) {}

Member Function Documentation

◆ addRef()

int Token::addRef ( )

inlineinherited

Increase reference count.

Definition at line 62 of file Token.h.

62 { return ++m_refCount; }

◆ addTypeSetting()

void pool::DbToken::addTypeSetting ( int val )

inline

Add type setting.

Definition at line 84 of file DbToken.h.

84 { setType(type() | val); }

◆ auxString()

const std::string& Token::auxString ( ) const

inlineinherited

Access auxiliary string.

Definition at line 91 of file Token.h.

91 { return m_auxString; }

◆ classID()

const Guid& Token::classID ( ) const

inlineinherited

Access database identifier.

Definition at line 73 of file Token.h.

73 { return m_classID; }

◆ contID()

const std::string& Token::contID ( ) const

inlineinherited

Access container identifier.

Definition at line 69 of file Token.h.

69 { return m_cntID; }

◆ contKey()

const Guid& pool::DbToken::contKey ( ) const

inline

Access to user key #1.

Definition at line 90 of file DbToken.h.

90 { return m_contKey; }

◆ dbID()

const Guid& Token::dbID ( ) const

inlineinherited

Access database identifier.

Definition at line 64 of file Token.h.

64 { return m_dbID; }

◆ equal()

virtual bool pool::DbToken::equal ( const Token & pTok ) const

virtual

Fast token comparison: operator equal.

Reimplemented from Token.

◆ fromString()

Token & Token::fromString ( const std::string & from )

inherited

Build from the string representation of a token.

Definition at line 148 of file Token.cxx.

                                                    {
    m_auxString.clear();
    for (const char* p1 = source.c_str(); p1; p1 = ::strchr(++p1,'[')) {
       const char* p2 = ::strchr(p1, '=');
       const char* p3 = ::strchr(p1, ']');
       if (p2 != 0 && p3 != 0) {
          if (::strncmp("[DB=", p1, 4) == 0)  {
             m_dbID.fromString(p1 + 4);
          } else if (::strncmp("[CNT=", p1, 5) == 0) {
             m_cntID.assign (p2+1, p3-p2-1);
          } else if (::strncmp(fmt_oid, p1, 5) == 0) {
             long long unsigned int first, second;
             if (::strncmp("]", p1 + 22, 1) == 0) { // 5 + 8(int) + 1(minus) + 8(int) = 22
                ::sscanf(p1, fmt_oid_old, &first, &second);
                if (int(first) == ~0x0) first = ~0x0LL;
                if (int(second) == ~0x0) second = ~0x0LL;
             } else {
                ::sscanf(p1, fmt_oid, &first, &second);
             }
             m_oid.first = first;
             m_oid.second = second;
          } else if (::strncmp(fmt_clid, p1, 6) == 0) {
             m_classID.fromString(p1 + 6);
          } else if (::strncmp(fmt_tech, p1, 6) == 0) {
             ::sscanf(p1, fmt_tech, &m_technology);
          } else {
             while (*(p2 + 1) == '[' && p3 && *(++p3) != 0 && *p3 != ']') {
                p3 = ::strchr(p3, ']');
             }
             if (!p3) p3 = source.c_str() + source.size();
             m_auxString.append (p1, p3-p1);
             m_auxString += ']';
          }
       }
    }
    return *this;
 }

◆ fullKey()

const Guid& pool::DbToken::fullKey ( ) const

inline

Access to user key identifying full token.

Definition at line 88 of file DbToken.h.

88 { return m_keyFull; }

◆ isLocal()

bool pool::DbToken::isLocal ( ) const

inline

Access local flag.

Definition at line 82 of file DbToken.h.

82 { return m_local; }

◆ key()

const std::string Token::key ( ) const

virtualinherited

Retrieve token key.

Retrieve the string representation of the token.

Definition at line 187 of file Token.cxx.

                                  {
    char text[1024];
    int s = ::sprintf(text, "][TECH=%08X]", m_technology & KEY_MASK);
    std::string k = "[DB=";
    k += m_dbID.toString();
    k += "][CNT=";
    k += m_cntID;
    k += "][CLID=";
    k += m_classID.toString();
    k.append(text, s);
    return k;
 }

◆ less()

virtual bool pool::DbToken::less ( const Token & pTok ) const

virtual

Fast token comparison: operator less.

Reimplemented from Token.

◆ makeKey()

static void pool::DbToken::makeKey	(	const Token *	tok,
		int	which,
		Guid &	guid
	)

static

Produce the token keys only on demand for export.

◆ numInstances()

int Token::numInstances ( )

staticinherited

expose Token instance counter for debugging

Definition at line 19 of file Token.cxx.

19 { return s_numCount; }

◆ oid() [1/2]

OID_t& Token::oid ( )

inlineinherited

Access object identifier.

Definition at line 83 of file Token.h.

83 { return m_oid; }

◆ oid() [2/2]

const OID_t& Token::oid ( ) const

inlineinherited

Access object identifier.

Definition at line 81 of file Token.h.

81 { return m_oid; }

◆ operator!=()

bool Token::operator!= ( const Token & refToken ) const

inlineinherited

Equality operator.

Definition at line 54 of file Token.h.

54 { return !equal(refToken); }

◆ operator<()

bool Token::operator< ( const Token & refToken ) const

inlineinherited

Operator < to allow ordering.

Definition at line 45 of file Token.h.

45 { return less(refToken); }

◆ operator==()

bool Token::operator== ( const Token & refToken ) const

inlineinherited

Equality operator.

Definition at line 52 of file Token.h.

52 { return equal(refToken); }

◆ operator>()

bool Token::operator> ( const Token & refToken ) const

inlineinherited

Operator > to allow ordering.

Definition at line 47 of file Token.h.

                                                { 
       if (less(refToken)) return false;
       return !equal(refToken);
    }

◆ release()

int Token::release ( )

inherited

Release token: Decrease reference count and eventually delete.

Definition at line 75 of file Token.cxx.

                    {
    int cnt = --m_refCount;
    if (0 >= cnt) {
       delete this;
    }
    return cnt;
 }

◆ removeTypeSetting()

void pool::DbToken::removeTypeSetting ( int val )

inline

Add type setting.

Definition at line 86 of file DbToken.h.

86 { setType(type() & ~val); }

◆ set()

const Token & Token::set ( Token * pToken ) const

inherited

Set token information.

Definition at line 200 of file Token.cxx.

                                            {
    pToken->m_technology = m_technology;
    pToken->m_dbID = m_dbID;
    pToken->m_cntID = m_cntID;
    pToken->m_classID = m_classID;
    pToken->m_oid.first = m_oid.first;
    return *this;
 }

◆ setAuxString()

Token& Token::setAuxString ( const std::string & auxString )

inlineinherited

Set auxiliary string.

Definition at line 93 of file Token.h.

93 { m_auxString = auxString; return *this; }

◆ setClassID()

Token& Token::setClassID ( const Guid & cl_id )

inlineinherited

Access database identifier.

Definition at line 75 of file Token.h.

75 { m_classID = cl_id; return *this; }

◆ setCont()

Token& Token::setCont ( const std::string & cnt )

inlineinherited

Set container name.

Definition at line 71 of file Token.h.

71 { m_cntID = cnt; return *this; }

◆ setData()

const Token & Token::setData ( Token * pToken ) const

inherited

Set all the data part of the token.

Definition at line 209 of file Token.cxx.

                                                {
    this->set(pToken);
    pToken->m_oid.second = m_oid.second;
    pToken->m_type = m_type;
    pToken->m_auxString = m_auxString;
    return *this;
 }

◆ setDb() [1/2]

Token& Token::setDb ( const Guid & db )

inlineinherited

Set database name.

Definition at line 66 of file Token.h.

66 { m_dbID = db; return *this; }

◆ setDb() [2/2]

Token& Token::setDb ( const std::string & db )

inlineinherited

Definition at line 67 of file Token.h.

67 { m_dbID.fromString(db); return *this; }

◆ setKey()

void pool::DbToken::setKey ( int which )

Produce the keys only on demand.

◆ setKeyEx()

void pool::DbToken::setKeyEx	(	int	which,
		const Guid &	guid
	)

Copy the key.

◆ setLocal()

void pool::DbToken::setLocal ( bool val )

inline

Set local flag.

Definition at line 80 of file DbToken.h.

80 { m_local = val; }

◆ setOid()

Token& Token::setOid ( const OID_t & oid )

inlineinherited

Set object identifier.

Definition at line 85 of file Token.h.

85 { m_oid = oid; return *this; }

◆ setTechnology()

Token& Token::setTechnology ( int t )

inlineinherited

Set technology type.

Definition at line 79 of file Token.h.

79 { m_technology = t; return *this; }

◆ setType()

Token& Token::setType ( int t )

inlineinherited

Set token type.

Definition at line 89 of file Token.h.

89 { m_type = t; return *this; }

◆ setTypeInfo()

void pool::DbToken::setTypeInfo ( const DbTypeInfo * t )

inline

Update type information.

Definition at line 76 of file DbToken.h.

76 { m_info = t; }

◆ setUserKey()

void pool::DbToken::setUserKey	(	int	i,
		const Guid &	guid
	)

Set a user key.

◆ technology()

int Token::technology ( ) const

inlineinherited

Access technology type.

Definition at line 77 of file Token.h.

77 { return m_technology; }

◆ toString()

const std::string Token::toString ( ) const

virtualinherited

Retrieve the string representation of the token.

Definition at line 129 of file Token.cxx.

                                       {
    char text1[128];
    int s1 = sprintf(text1, fmt_tech, m_technology);
    char text2[128];
    int s2 = sprintf(text2, fmt_oid, m_oid.first, m_oid.second);
    std::string str = "[DB=";
    str.reserve(32);
    str += m_dbID.toString();
    str += "][CNT=";
    str += m_cntID;
    str += "][CLID=";
    str += m_classID.toString();
    str += ']';
    str.append(text1, s1);
    str.append(text2, s2);
    str += m_auxString;
    return str;
 }

◆ type()

int Token::type ( ) const

inlineinherited

Access token type.

Definition at line 87 of file Token.h.

87 { return m_type; }

◆ typeInfo()

const DbTypeInfo* pool::DbToken::typeInfo ( ) const

inline

Access type information.

Definition at line 78 of file DbToken.h.

78 { return m_info; }

◆ userkey()

const Guid& pool::DbToken::userkey ( int i ) const

inline

Access to optional user keys #2.

Definition at line 92 of file DbToken.h.

92 { return m_ukeys[i]; }

Member Data Documentation

◆ m_auxString

std::string Token::m_auxString

privateinherited

Auxiliary string.

Definition at line 125 of file Token.h.

◆ m_classID

Guid Token::m_classID

privateinherited

Object global identifier.

Definition at line 119 of file Token.h.

◆ m_cntID

std::string Token::m_cntID

privateinherited

Container identifier.

Definition at line 117 of file Token.h.

◆ m_contKey

Guid pool::DbToken::m_contKey

private

Buffer to hold user key #1.

Definition at line 53 of file DbToken.h.

◆ m_dbID

Guid Token::m_dbID

privateinherited

Database identifier.

Definition at line 115 of file Token.h.

◆ m_info

const DbTypeInfo* pool::DbToken::m_info

private

Database type information cache.

Definition at line 57 of file DbToken.h.

◆ m_keyFull

Guid pool::DbToken::m_keyFull

private

Buffer to hold user key identifying full token.

Definition at line 51 of file DbToken.h.

◆ m_local

bool pool::DbToken::m_local

private

Flag to indicate if toekn is local or foreign.

Definition at line 59 of file DbToken.h.

◆ m_oid

OID_t Token::m_oid

privateinherited

Persistent object identifier.

Definition at line 121 of file Token.h.

◆ m_refCount

int Token::m_refCount

privateinherited

Reference count.

Definition at line 111 of file Token.h.

◆ m_technology

unsigned int Token::m_technology

privateinherited

Technology identifier.

Definition at line 113 of file Token.h.

◆ m_type

int Token::m_type

privateinherited

Token type.

Definition at line 123 of file Token.h.

◆ m_ukeys

std::vector< Guid > pool::DbToken::m_ukeys

private

Optional other user keys.

Definition at line 55 of file DbToken.h.

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

DbToken.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DbToken()

Member Function Documentation

◆ addRef()

◆ addTypeSetting()

◆ auxString()

◆ classID()

◆ contID()

◆ contKey()

◆ dbID()

◆ equal()

◆ fromString()

◆ fullKey()

◆ isLocal()

◆ key()

◆ less()

◆ makeKey()

◆ numInstances()

◆ oid() [1/2]

◆ oid() [2/2]

◆ operator!=()

◆ operator<()

◆ operator==()

◆ operator>()

◆ release()

◆ removeTypeSetting()

◆ set()

◆ setAuxString()

◆ setClassID()

◆ setCont()

◆ setData()

◆ setDb() [1/2]

◆ setDb() [2/2]

◆ setKey()

◆ setKeyEx()

◆ setLocal()

◆ setOid()

◆ setTechnology()

◆ setType()

◆ setTypeInfo()

◆ setUserKey()

◆ technology()

◆ toString()

◆ type()

◆ typeInfo()

◆ userkey()

Member Data Documentation

◆ m_auxString

◆ m_classID

◆ m_cntID

◆ m_contKey

◆ m_dbID

◆ m_info

◆ m_keyFull

◆ m_local

◆ m_oid

◆ m_refCount

◆ m_technology

◆ m_type

◆ m_ukeys