RWDBStoredProcEntry Class Reference

Class to hold RWDBStoredProc metadata for cache managers. More...

#include <rw/db/cachemgr.h>

Public Member Functions
	RWDBStoredProcEntry ()
	RWDBStoredProcEntry (const RWDBStoredProcEntry &entry)
void	clearExists ()
void	clearParams ()
void	clearReturnValue ()
void	clearText ()
bool	getExists () const
RWDBSchema	getParams () const
RWDBColumn	getReturnValue () const
RWCString	getText () const
bool	hasExists () const
bool	hasParams () const
bool	hasReturnValue () const
bool	hasText () const
RWDBStoredProcEntry &	operator= (const RWDBStoredProcEntry &entry)
void	setExists (bool exists)
void	setParams (const RWDBSchema &schema)
void	setReturnValue (const RWDBColumn &col)
void	setText (const RWCString &text)

Friends
RWvostream &	operator<< (RWvostream &strm, const RWDBStoredProcEntry &item)
RWFile &	operator<< (RWFile &file, const RWDBStoredProcEntry &item)
RWvistream &	operator>> (RWvistream &strm, RWDBStoredProcEntry &obj)
RWFile &	operator>> (RWFile &file, RWDBStoredProcEntry &obj)

Detailed Description

RWDBStoredProcEntry is a class for moving RWDBStoredProc metadata in and out of a cache manager class that inherits from RWDBCacheManager.

Synopsis

#include <rw/db/cachemgr.h>
#include <rw/tvhmap.h>

class MyCacheManager : public RWDBCacheManager
{
    void setStoredProc(const RWCString& name, const RWDBStoredProcEntry& spEntry) {
        spCache.insert(name, spEntry);
    }

    RWDBStoredProcEntry getStoredProc(const RWCString& name) const {
        RWDBStoredProcEntry spEntry;
        spCache.findValue(name, spEntry);
        return spEntry;
    }
private:
    RWTValHashMap<RWCString, RWDBStoredProcEntry> spCache;
};

Constructor & Destructor Documentation

RWDBStoredProcEntry::RWDBStoredProcEntry

(

)

Constructs an empty object with no metadata information.

RWDBStoredProcEntry::RWDBStoredProcEntry

(

const RWDBStoredProcEntry &

entry

)

Copies all metadata information from entry.

Member Function Documentation

void RWDBStoredProcEntry::clearExists

(

)

Clears the value of the exists flag. After this call, hasExists() returns false.

void RWDBStoredProcEntry::clearParams

(

)

Clears the parameter list on self. After this call hasParams() returns false.

void RWDBStoredProcEntry::clearReturnValue

(

)

Clears the return value column on self. After this call hasReturnValue() returns false.

void RWDBStoredProcEntry::clearText

(

)

Clears the text on self. After this call hasText() returns false.

bool RWDBStoredProcEntry::getExists

(

)

const

Returns the value of the exists flag.

Note

If hasExists() returns false this function returns false.

RWDBSchema RWDBStoredProcEntry::getParams

(

)

const

Returns the parameter list set on self.

Note

If hasParams() returns false this call returns an empty RWDBSchema.

RWDBColumn RWDBStoredProcEntry::getReturnValue

(

)

const

Returns the return value column set on self.

Note

If hasReturnValue() returns false this call returns an empty RWDBColumn.

RWCString RWDBStoredProcEntry::getText

(

)

const

Returns the text set on self.

Note

If hasText() returns false this call returns an empty RWCString.

bool RWDBStoredProcEntry::hasExists

(

)

const

Returns true if the exists flag has been set on self.

bool RWDBStoredProcEntry::hasParams

(

)

const

Returns true if a parameter list has been set on self.

bool RWDBStoredProcEntry::hasReturnValue

(

)

const

Returns true if the return value column has been set on self.

bool RWDBStoredProcEntry::hasText

(

)

const

Returns true if the text has been set on self.

RWDBStoredProcEntry& RWDBStoredProcEntry::operator=

(

const RWDBStoredProcEntry &

entry

)

Copies all metadata information from entry.

void RWDBStoredProcEntry::setExists

(

bool

exists

)

Sets exists flag on self. After this call, hasExists() returns true.

void RWDBStoredProcEntry::setParams

(

const RWDBSchema &

schema

)

Sets the parameter list on self. After this call hasParams() returns true.

void RWDBStoredProcEntry::setReturnValue

(

const RWDBColumn &

col

)

Sets the return value column on self. After this call hasReturnValue() returns true.

void RWDBStoredProcEntry::setText

(

const RWCString &

text

)

Sets the text on self. After this call hasText() returns true.

Friends And Related Function Documentation

RWvostream& operator<< ( RWvostream &  strm, const RWDBStoredProcEntry &  item  )

friend

Saves the object item to a virtual stream. Recursively calls the function saveGuts(), taking duplicate objects into account. See the discussion on Persistence in the Essential Tools Module User's Guide for more information.

RWFile& operator<< ( RWFile &  file, const RWDBStoredProcEntry &  item  )

friend

Saves the object item to an RWFile. Recursively calls the function saveGuts(), taking duplicate objects into account. See the discussion on Persistence in the Essential Tools Module User's Guide for more information.

RWvistream& operator>> ( RWvistream &  strm, RWDBStoredProcEntry &  obj  )

friend

Restores an RWDBStoredProcEntry into obj from a virtual stream, replacing the previous contents of obj. Recursively calls the function restoreGuts(), taking duplicate objects into account. For more information, see the discussion on Persistence in the Essential Tools Module User's Guide.

RWFile& operator>> ( RWFile &  file, RWDBStoredProcEntry &  obj  )

friend

Restores an RWDBStoredProcEntry into obj from an RWFile, replacing the previous contents of obj. Recursively calls the function restoreGuts(), taking duplicate objects into account. For more information, see the discussion on Persistence in the Essential Tools Module User's Guide.