IliSQLTableRef Class Reference

User interface class. More...

#include <ilviews/dataccess/tblref.h>

List of all members.

Public Member Functions
	IliSQLTableRef (const IliSQLTableRef &)
	This is the copy constructor of class 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.
	IliSQLTableRef (const char *tableName=0, const char *tableOwner=0, const char *database=0)
	This constructor initializes a table reference.
const char *	getDatabase () const
	Returns the database name of the referenced table.
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.
const char *	getTableOwner () const
	Returns the owner name of the referenced table.
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.
int	operator== (const IliSQLTableRef &ref) const
	Compares two table references.
void	read (IL_STDPREF istream &input)
	Reads the definition of the table reference from an input stream.
void	setDatabase (const char *database)
	Sets the database name of the referenced table.
IlBoolean	setSynLink (const char *synLink)
	Sets the synonym link to given value.
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.
void	setSynonym (IlBoolean flag=IlTrue)
	Sets the table reference as a synonym reference or not.
IlBoolean	setSynOwner (const char *synOwner)
	Sets the synonym owner to given value.
void	setTableName (const char *tableName)
	Sets the name of the referenced table.
void	setTableOwner (const char *tableOwner)
	Sets the owner name of the referenced table.
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.

---

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:

	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.

Parameters:

	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.

---

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:

ref

The table reference.

int IliSQLTableRef::operator==

(

const IliSQLTableRef &

ref

)

const

Compares two table references.

Parameters:

ref

The 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:

input

The input stream.

void IliSQLTableRef::setDatabase

(

const char *

database

)

Sets the database name of the referenced table.

Parameters:

database

The database name.

IlBoolean IliSQLTableRef::setSynLink

(

const char *

synLink

)

Sets the synonym link to given value.

Parameters:

synLink

The 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:

synName

The 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:

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.

Parameters:

synOwner

The 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:

tableName

The table name.

void IliSQLTableRef::setTableOwner

(

const char *

tableOwner

)

Sets the owner name of the referenced table.

Parameters:

tableOwner

The 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:

output

The output stream.