 |
Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
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*. | |
| IliSQLTableRef & | operator= (const IliSQLTableRef &ref) |
| Assigns a table reference. More... | |
| int | operator== (const IliSQLTableRef &ref) const |
| Compares two table references. More... | |
| void | read (std::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 (std::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... | |
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.
| IliSQLTableRef::IliSQLTableRef | ( | const char * | tableName = 0, |
| const char * | tableOwner = 0, |
||
| const char * | database = 0 |
||
| ) |
This constructor initializes a table reference.
| tableName | The table name. |
| tableOwner | The table owner name. |
| database | The 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.
| synName | The name of the synonym. |
| synOwner | The owner of the synonym. |
| link | The synonym link. |
| tableName | The target table name. |
| tableOwner | The target table owner. |
| database | The target table database. |
| const char * IliSQLTableRef::getDatabase | ( | ) | const |
Returns the database name of the referenced table.
| const char * IliSQLTableRef::getTableName | ( | ) | const |
Returns the name of the referenced table.
| const char * IliSQLTableRef::getTableOwner | ( | ) | const |
Returns the owner name of the referenced table.
| IliSQLTableRef& IliSQLTableRef::operator= | ( | const IliSQLTableRef & | ref | ) |
Assigns a table reference.
| ref | The table reference. |
| int IliSQLTableRef::operator== | ( | const IliSQLTableRef & | ref | ) | const |
Compares two table references.
| ref | The second table reference. |
1 if the table reference is equal to the tblRef parameter. | void IliSQLTableRef::read | ( | std::istream & | input | ) |
Reads the definition of the table reference from an input stream.
| input | The input stream. |
| void IliSQLTableRef::setDatabase | ( | const char * | database | ) |
Sets the database name of the referenced table.
| database | The database name. |
| IlBoolean IliSQLTableRef::setSynLink | ( | const char * | synLink | ) |
Sets the synonym link to given value.
| synLink | The value to set. |
| 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.
| synName | The name of the synonym. |
Sets the table reference as a synonym reference or not.
| flag | Set it to IlTrue to set the object as a synonym reference. |
| IlBoolean IliSQLTableRef::setSynOwner | ( | const char * | synOwner | ) |
Sets the synonym owner to given value.
| synOwner | The owner name to set for the instance. |
| void IliSQLTableRef::setTableName | ( | const char * | tableName | ) |
Sets the name of the referenced table.
| tableName | The table name. |
| void IliSQLTableRef::setTableOwner | ( | const char * | tableOwner | ) |
Sets the owner name of the referenced table.
| tableOwner | The owner name. |
| void IliSQLTableRef::write | ( | std::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.
| output | The output stream. |
© Copyright 2016, 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.