RWDBForeignKeyList Class Reference

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

#include <rw/db/forkey.h>

Inheritance diagram for RWDBForeignKeyList:

Public Member Functions
	RWDBForeignKeyList ()
	RWDBForeignKeyList (const RWDBForeignKeyList &aList)
RWDBForeignKeyList	clone () const
RWDBForeignKeyList &	operator= (const RWDBForeignKeyList &aList)
RWDBForeignKey &	operator[] (size_t index) const
Public Member Functions inherited from RWOrdered
	RWOrdered (size_t size=RWCollection::DEFAULT_CAPACITY)
	RWOrdered (const RWOrdered &o)
	RWOrdered (RWOrdered &&o)
virtual RWCollectable *	append (RWCollectable *a)
virtual void	apply (RWapplyCollectable ap, void *x)
virtual RWCollectable *&	at (size_t i)
virtual const RWCollectable *	at (size_t i) const
virtual void	clear ()
virtual size_t	entries () const
virtual RWCollectable *	find (const RWCollectable *target) const
virtual RWCollectable *	first () const
virtual size_t	index (const RWCollectable *c) const
virtual RWCollectable *	insert (RWCollectable *c)
virtual RWCollectable *	insertAt (size_t indx, RWCollectable *e)
virtual RWClassID	isA () const
virtual bool	isEmpty () const
virtual bool	isEqual (const RWCollectable *a) const
virtual RWCollectable *	last () const
virtual size_t	newCapacity (size_t) const
virtual RWConstIterator *	newConstIterator () const
virtual RWIterator *	newIterator ()
virtual RWCollectable *	newSpecies () const
virtual size_t	occurrencesOf (const RWCollectable *target) const
RWCollectable *&	operator() (size_t i)
RWOrdered &	operator= (const RWOrdered &o)
RWOrdered &	operator= (RWOrdered &&o)
bool	operator== (const RWOrdered &od) const
RWCollectable *&	operator[] (size_t i)
RWCollectable *	pop ()
virtual RWCollectable *	prepend (RWCollectable *c)
void	push (RWCollectable *c)
virtual RWCollectable *	remove (const RWCollectable *target)
RWCollectable *	removeAt (size_t index)
void	swap (RWOrdered &o)
RWCollectable *	top () const

Additional Inherited Members
Static Public Member Functions inherited from RWCollectable
static RWClassID	classID (const RWStringID &name)
static RWClassID	classIsA ()
static bool	isAtom (RWClassID id)
static RWspace	nilStoreSize ()
Static Public Attributes inherited from RWCollection
static size_t	DEFAULT_CAPACITY
Related Functions inherited from RWCollection
typedef void(*	RWapplyCollectable )(RWCollectable *, void *)
typedef bool(*	RWtestCollectable )(const RWCollectable *, const void *)
typedef bool(*	RWtestCollectablePair )(const RWCollectable *, const RWCollectable *, const void *)

Detailed Description

RWDBForeignKeyList is an ordered collection of RWDBForeignKey instances. RWDBForeignKeyList is a relatively low-level construct used by the DB Interface Module as an input/output parameter in the functions RWDBTable::foreignKeys() and RWDBTable::referredToBy().

All RWDBForeignKeyList methods are inherited from RWOrdered.

The only semantics that RWDBForeignKeyList adds to RWOrdered are:

• The index operator operator[]() returns reference to RWDBForeignKey, rather than reference to RWCollectable pointer.
• The destructor deallocates the contents of the RWDBForeignKeyList by calling clearAndDestroy().

Synopsis

#include <rw/db/forkey.h>
RWDBForeignKeyList aList;

RWDBStatus aStatus = aTable.foreignKeys("targetTable", aList);

Constructor & Destructor Documentation

RWDBForeignKeyList::RWDBForeignKeyList

(

)

The default constructor produces an empty RWDBForeignKeyList.

RWDBForeignKeyList::RWDBForeignKeyList ( const RWDBForeignKeyList &  aList )

inline

Copy constructor. Makes a copy of aList.

Member Function Documentation

RWDBForeignKeyList RWDBForeignKeyList::clone ( ) const

inline

Returns a deep copy of self.

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

inline

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

RWDBForeignKey& RWDBForeignKeyList::operator[]

(

size_t

index

)

const

Returns a reference to the RWDBForeignKey at a position index in self. The call is forwarded to RWOrdered, which throws an exception of type RWBoundsErr if the index is out of range.