RWDBUniqueConstraintList Class Reference

Holds an ordered collection of RWDBUniqueConstraint instances. More...

#include <rw/db/uniqueconstr.h>

Public Member Functions
	RWDBUniqueConstraintList ()
	RWDBUniqueConstraintList (const RWDBUniqueConstraintList &aList)
	~RWDBUniqueConstraintList ()
RWDBUniqueConstraint *	append (RWDBUniqueConstraint *uc)
RWspace	binaryStoreSize () const
void	clear ()
void	clearAndDestroy ()
RWDBUniqueConstraintList	clone () const
size_t	entries () const
const RWDBUniqueConstraint &	operator() (size_t index) const
RWDBUniqueConstraint &	operator() (size_t index)
RWDBUniqueConstraintList &	operator= (const RWDBUniqueConstraintList &aList)
const RWDBUniqueConstraint &	operator[] (size_t index) const
RWDBUniqueConstraint &	operator[] (size_t index)
RWDBUniqueConstraint *	removeAt (size_t index)
void	restoreGuts (RWFile &f)
void	restoreGuts (RWvistream &s)
void	saveGuts (RWFile &f) const
void	saveGuts (RWvostream &s) const

Detailed Description

RWDBUniqueConstraintList is an ordered collection of RWDBUniqueConstraint instances. RWDBUniqueConstraintList is used by the DB Interface Module as an input/output parameter in the function RWDBTable::uniqueConstraints(). When the list is populated with instances of RWDBUniqueConstraint, the instances are owned by the containing list. The destructor deallocates the contents of the RWDBUniqueConstraintList by calling clearAndDestroy().

Synopsis

#include <rw/db/uniqueconstr.h>
RWDBUniqueConstraintList aList;

aStatus = aTable.uniqueConstraints("aConstraintName", aList);

Constructor & Destructor Documentation

RWDBUniqueConstraintList::RWDBUniqueConstraintList ( )

inline

Constructor.

RWDBUniqueConstraintList::RWDBUniqueConstraintList ( const RWDBUniqueConstraintList &  aList )

inline

Copy constructor. Makes a copy aList.

RWDBUniqueConstraintList::~RWDBUniqueConstraintList ( )

inline

Destructor. This deletes the objects in the list.

Member Function Documentation

RWDBUniqueConstraint* RWDBUniqueConstraintList::append ( RWDBUniqueConstraint *  uc )

inline

Adds uc to the end of the collection and returns it. If successful, self assumes ownership of uc. Returns rwnil if the insertion was unsuccessful.

RWspace RWDBUniqueConstraintList::binaryStoreSize ( ) const

inline

Returns the number of bytes required to store self using the saveGuts() method.

void RWDBUniqueConstraintList::clear ( )

inline

Removes all objects from the collection. Does not delete the objects themselves.

void RWDBUniqueConstraintList::clearAndDestroy ( )

inline

Removes all objects from the collection and deletes them. Takes into account duplicate objects within the collection and only deletes them once. However, it does not take into account objects shared with another collection.

RWDBUniqueConstraintList RWDBUniqueConstraintList::clone ( ) const

inline

Returns a new list that is a deep copy of self.

size_t RWDBUniqueConstraintList::entries ( ) const

inline

Returns the total number of items in the collection.

const RWDBUniqueConstraint& RWDBUniqueConstraintList::operator() ( size_t  index ) const

inline

Returns a reference to the RWDBUniqueConstraint at a position index in self. Bounds checking is enabled by defining the preprocessor directive RWBOUNDS_CHECK before including the header file rw\db\uniqueconstr.h. In this case, throws RWBoundsErr if the index is out of range.

RWDBUniqueConstraint& RWDBUniqueConstraintList::operator() ( size_t  index )

inline

Returns a reference to the RWDBUniqueConstraint at a position index in self. Bounds checking is enabled by defining the preprocessor directive RWBOUNDS_CHECK before including the header file rw\db\uniqueconstr.h. In this case, throws RWBoundsErr if the index is out of range.

RWDBUniqueConstraintList& RWDBUniqueConstraintList::operator= ( const RWDBUniqueConstraintList &  aList )

inline

Assignment operator. Destroys contents of self and makes a copy of aList.

const RWDBUniqueConstraint& RWDBUniqueConstraintList::operator[] ( size_t  index ) const

inline

Returns a reference to the RWDBUniqueConstraint at a position index in self. Throws RWBoundsErr if the index is out of range.

RWDBUniqueConstraint& RWDBUniqueConstraintList::operator[] ( size_t  index )

inline

Returns a reference to the RWDBUniqueConstraint at a position index in self. Throws RWBoundsErr if the index is out of range.

RWDBUniqueConstraint* RWDBUniqueConstraintList::removeAt ( size_t  index )

inline

Removes the oject at the position index in the collection and returns it. It is up to the user to delete the returned object.

void RWDBUniqueConstraintList::restoreGuts ( RWFile &  f )

inline

Reads f, replacing the contents of self.

void RWDBUniqueConstraintList::restoreGuts ( RWvistream &  s )

inline

Reads s, replacing the contents of self.

void RWDBUniqueConstraintList::saveGuts ( RWFile &  f ) const

inline

Writes the contents of self to f.

void RWDBUniqueConstraintList::saveGuts ( RWvostream &  s ) const

inline

Writes the contents of self to s.