Join Class Reference

This class represents a checked join between two tables. More...

#include <Join.h>

List of all members.

Public Member Functions

 Join (TableImplPtr nativeTable, TableImplPtr joinTable, KeyImplPtr nativeKey, KeyImplPtr foreignKey)
 Construct a Join between the specified tables with the specified keys.
 ~Join ()
 Destructor, a noop.
TableImplPtr getNativeTable () const
 Returns the native table.
TableImplPtr getJoinTable () const
 Returns the join table.
KeyImplPtr getNativeKey () const
 Returns the native key.
KeyImplPtr getForeignKey () const
 Returns the foreign key.


Detailed Description

This class represents a checked join between two tables.

With this class a join may be specified bewteen two tables. The native key should belong to the native table and the foreign key to the join table. Only one of the two keys may be a non-foreign key. Even so, either key should point to the other table. This is asserted at run-time.

Definition at line 40 of file Join.h.


Constructor & Destructor Documentation

Join::Join ( TableImplPtr  nativeTable,
TableImplPtr  joinTable,
KeyImplPtr  nativeKey,
KeyImplPtr  foreignKey 
)

Construct a Join between the specified tables with the specified keys.

Join::~Join (  ) 

Destructor, a noop.


Member Function Documentation

TableImplPtr Join::getNativeTable (  )  const

Returns the native table.

TableImplPtr Join::getJoinTable (  )  const

Returns the join table.

KeyImplPtr Join::getNativeKey (  )  const

Returns the native key.

KeyImplPtr Join::getForeignKey (  )  const

Returns the foreign key.


Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo