IliSQLCatalog Class Reference

User interface class. More...

#include <ilviews/dataccess/tbldef.h>

List of all members.

Public Member Functions
	IliSQLCatalog (const IliSQLCatalog &)
	This is the copy constructor of class IliSQLCatalog.
	IliSQLCatalog (IlvDisplay *display)
	This constructor initializes an empty catalog.
IlInt	appendTableDef (IliSQLTableDef *)
	Appends the table definition at the end of the catalog.
void	deleteAll ()
	Removes and deletes all the table definitions in the catalog.
IlvDisplay *	getDisplay () const
	Returns the display of the catalog.
IliSQLTableDef *	getTableDef (const IliSQLTableRef &ref)
	Returns the first table definition in the catalog with a given table reference.
const IliSQLTableDef *	getTableDef (const IliSQLTableRef &ref) const
	Returns the first table definition in the catalog with a given table reference.
IliSQLTableDef *	getTableDef (IlInt p)
	Returns the table definition.
const IliSQLTableDef *	getTableDef (IlInt p) const
	Returns the table definition.
IlInt	getTableDefIndex (const IliSQLTableDef *tdef) const
	Returns the position, in the catalog, of the table definition.
IlInt	getTableDefIndex (const IliSQLTableRef &ref) const
	Returns the position, in the catalog, of the first table definition with a specific table reference.
IlInt	getTableDefsCount () const
	Returns the number of table definitions in the catalog.
IlBoolean	insertTableDef (IlInt pos, IliSQLTableDef *def)
	Inserts a table definition in the catalog.
void	read (IL_STDPREF istream &input)
	Reads the definition of the catalog from an input stream.
void	removeTableDef (IlInt index, IlBoolean deleteIt=IlTrue)
	Removes the table definition from the catalog.
void	write (IL_STDPREF ostream &output) const
	Writes the definition of the catalog to an output stream in a form suitable to be read back by the read member function.

---

Detailed Description

User interface class.

Library: dataccess

An IliSQLCatalog contains an ordered collection of IliSQLTableDef objects. It is used to hold a subset of the schema of a database.

See also:

IliSQLTableDef, IliSQLTableRef

---

Constructor & Destructor Documentation

IliSQLCatalog::IliSQLCatalog

(

IlvDisplay *

display

)

This constructor initializes an empty catalog.

Parameters:

display

The display.

---

Member Function Documentation

IlInt IliSQLCatalog::appendTableDef

(

IliSQLTableDef *

)

Appends the table definition at the end of the catalog.

Parameters:

	def	The table definition. Once a table definition has been inserted into a catalog, the catalog becomes the owner of this table definition.
	def	The table definition.

Returns:

The insertion position.

IlvDisplay* IliSQLCatalog::getDisplay

(

)

const

Returns the display of the catalog.

Returns:

The display of the catalog.

IliSQLTableDef* IliSQLCatalog::getTableDef

(

const IliSQLTableRef &

ref

)

Returns the first table definition in the catalog with a given table reference.

Parameters:

ref

The table reference.

Returns:

The table definition, or NULL if no such table definition is found.

const IliSQLTableDef* IliSQLCatalog::getTableDef

(

const IliSQLTableRef &

ref

)

const

Returns the first table definition in the catalog with a given table reference.

Parameters:

ref

The table reference.

Returns:

The table definition, or NULL if no such table definition is found.

IliSQLTableDef* IliSQLCatalog::getTableDef

(

IlInt

p

)

Returns the table definition.

Parameters:

p

The position.

Returns:

The table definition.

const IliSQLTableDef* IliSQLCatalog::getTableDef

(

IlInt

p

)

const

Returns the table definition.

Parameters:

p

The position.

Returns:

The table definition.

IlInt IliSQLCatalog::getTableDefIndex

(

const IliSQLTableDef *

tdef

)

const

Returns the position, in the catalog, of the table definition.

Parameters:

tdef

The table definition.

Returns:

The position, in the catalog, of the table definition or -1 if it does not belong to the catalog.

IlInt IliSQLCatalog::getTableDefIndex

(

const IliSQLTableRef &

ref

)

const

Returns the position, in the catalog, of the first table definition with a specific table reference.

Parameters:

ref

The table reference.

Returns:

The position, or -1 if no such table definition is found.

IlInt IliSQLCatalog::getTableDefsCount

(

)

const

Returns the number of table definitions in the catalog.

Returns:

The number of table definitions in the catalog.

IlBoolean IliSQLCatalog::insertTableDef	(	IlInt	pos,
		IliSQLTableDef *	def
	)

Inserts a table definition in the catalog.

Parameters:

	pos	The insertion position.
	def	The table definition.

Returns:

IlTrue if successful.

void IliSQLCatalog::read

(

IL_STDPREF istream &

input

)

Reads the definition of the catalog from an input stream.

Parameters:

input

The input stream.

void IliSQLCatalog::removeTableDef	(	IlInt	index,
		IlBoolean	deleteIt = IlTrue
	)

Removes the table definition from the catalog.

Parameters:

	index	The table definition position.
	deleteIt	If IlTrue, the table definition object is also deleted.

void IliSQLCatalog::write

(

IL_STDPREF ostream &

output

)

const

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

Parameters:

output

The output stream.