rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IliSQLTableRef Class Reference

User interface class. More...

#include <ilviews/dataccess/tblref.h>

Public Member Functions

 IliSQLTableRef (const char *tableName=0, const char *tableOwner=0, const char *database=0)
 This constructor initializes a table reference. More...
 
 IliSQLTableRef (const char *synName, const char *synOwner, const char *link, const char *tableName, const char *tableOwner, const char *database)
 This constructor initializes a table reference as a synonym. More...
 
 IliSQLTableRef (const IliSQLTableRef &)
 This is the copy constructor of class IliSQLTableRef.
 
const char * getDatabase () const
 Returns the database name of the referenced table. More...
 
const char * getSynLink () const
 Returns the synonym target (valid only if isSynonym() is true.
 
const char * getSynName () const
 Returns the synonym name (valid only if isSynonym() is true.
 
const char * getSynOwner () const
 Returns the synonym owner (valid only if isSynonym() is true.
 
const char * getTableName () const
 Returns the name of the referenced table. More...
 
const char * getTableOwner () const
 Returns the owner name of the referenced table. More...
 
IlBoolean isSynonym () const
 Returns IlTrue if the referenced table is a synonym. This is the case except if current pointer is a IlSQLSynonymRef*.
 
IliSQLTableRefoperator= (const IliSQLTableRef &ref)
 Assigns a table reference. More...
 
int operator== (const IliSQLTableRef &ref) const
 Compares two table references. More...
 
void read (IL_STDPREF istream &input)
 Reads the definition of the table reference from an input stream. More...
 
void setDatabase (const char *database)
 Sets the database name of the referenced table. More...
 
IlBoolean setSynLink (const char *synLink)
 Sets the synonym link to given value. More...
 
IlBoolean setSynName (const char *synName)
 Sets the synonym name to given value. This member function is valid only if this instance is a reference for a synonym entity. More...
 
void setSynonym (IlBoolean flag=IlTrue)
 Sets the table reference as a synonym reference or not. More...
 
IlBoolean setSynOwner (const char *synOwner)
 Sets the synonym owner to given value. More...
 
void setTableName (const char *tableName)
 Sets the name of the referenced table. More...
 
void setTableOwner (const char *tableOwner)
 Sets the owner name of the referenced table. More...
 
void write (IL_STDPREF ostream &output) const
 Writes the definition of the table reference to an output stream, in a form suitable to be read back by the read member function. More...
 

Detailed Description

User interface class.

Library: dataccess

The IliSQLTableRef class is used to define references to SQL database tables. An SQL table is identified by its name and by the name of its owner. On some database systems, the name of a table may be further qualified by a database name. This class is required by the IliSQLTable, IliSQLTableDef, and IliSQLSession classes.

See Also
IliSQLSession, IliTable, IliSQLTableDef

Constructor & Destructor Documentation

IliSQLTableRef::IliSQLTableRef ( const char *  tableName = 0,
const char *  tableOwner = 0,
const char *  database = 0 
)

This constructor initializes a table reference.

Parameters
tableNameThe table name.
tableOwnerThe table owner name.
databaseThe database name.
IliSQLTableRef::IliSQLTableRef ( const char *  synName,
const char *  synOwner,
const char *  link,
const char *  tableName,
const char *  tableOwner,
const char *  database 
)

This constructor initializes a table reference as a synonym.

Parameters
synNameThe name of the synonym.
synOwnerThe owner of the synonym.
linkThe synonym link.
tableNameThe target table name.
tableOwnerThe target table owner.
databaseThe target table database.

Member Function Documentation

const char * IliSQLTableRef::getDatabase ( ) const

Returns the database name of the referenced table.

Returns
The database name of the referenced table.
const char * IliSQLTableRef::getTableName ( ) const

Returns the name of the referenced table.

Returns
The name of the referenced table.
const char * IliSQLTableRef::getTableOwner ( ) const

Returns the owner name of the referenced table.

Returns
The owner name of the referenced table.
IliSQLTableRef& IliSQLTableRef::operator= ( const IliSQLTableRef ref)

Assigns a table reference.

Parameters
refThe table reference.
int IliSQLTableRef::operator== ( const IliSQLTableRef ref) const

Compares two table references.

Parameters
refThe second table reference.
Returns
1 if the table reference is equal to the tblRef parameter.
void IliSQLTableRef::read ( IL_STDPREF istream &  input)

Reads the definition of the table reference from an input stream.

Parameters
inputThe input stream.
void IliSQLTableRef::setDatabase ( const char *  database)

Sets the database name of the referenced table.

Parameters
databaseThe database name.
IlBoolean IliSQLTableRef::setSynLink ( const char *  synLink)

Sets the synonym link to given value.

Parameters
synLinkThe value to set.
Returns
IlFalse if the instance does not reference a synonym entity.
IlBoolean IliSQLTableRef::setSynName ( const char *  synName)

Sets the synonym name to given value. This member function is valid only if this instance is a reference for a synonym entity.

Parameters
synNameThe name of the synonym.
Returns
IlFalse if the instance does not reference a synonym entity.
void IliSQLTableRef::setSynonym ( IlBoolean  flag = IlTrue)

Sets the table reference as a synonym reference or not.

Parameters
flagSet it to IlTrue to set the object as a synonym reference.
IlBoolean IliSQLTableRef::setSynOwner ( const char *  synOwner)

Sets the synonym owner to given value.

Parameters
synOwnerThe owner name to set for the instance.
Returns
IlFalse if the instance does not reference a synonym entity.
void IliSQLTableRef::setTableName ( const char *  tableName)

Sets the name of the referenced table.

Parameters
tableNameThe table name.
void IliSQLTableRef::setTableOwner ( const char *  tableOwner)

Sets the owner name of the referenced table.

Parameters
tableOwnerThe owner name.
void IliSQLTableRef::write ( IL_STDPREF ostream &  output) const

Writes the definition of the table reference to an output stream, in a form suitable to be read back by the read member function.

Parameters
outputThe output stream.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.