Rogue Wave Views
Data Access Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IliSQLCatalog Class Reference

User interface class. More...

#include <ilviews/dataccess/tbldef.h>

Public Member Functions

 IliSQLCatalog (IlvDisplay *display)
 This constructor initializes an empty catalog. More...
 
 IliSQLCatalog (const IliSQLCatalog &)
 This is the copy constructor of class IliSQLCatalog.
 
IlInt appendTableDef (IliSQLTableDef *def)
 Appends the table definition at the end of the catalog. More...
 
void deleteAll ()
 Removes and deletes all the table definitions in the catalog.
 
IlvDisplaygetDisplay () const
 Returns the display of the catalog. More...
 
const IliSQLTableDefgetTableDef (IlInt p) const
 Returns the table definition. More...
 
IliSQLTableDefgetTableDef (IlInt p)
 Returns the table definition. More...
 
const IliSQLTableDefgetTableDef (const IliSQLTableRef &ref) const
 Returns the first table definition in the catalog with a given table reference. More...
 
IliSQLTableDefgetTableDef (const IliSQLTableRef &ref)
 Returns the first table definition in the catalog with a given table reference. More...
 
IlInt getTableDefIndex (const IliSQLTableRef &ref) const
 Returns the position, in the catalog, of the first table definition with a specific table reference. More...
 
IlInt getTableDefIndex (const IliSQLTableDef *tdef) const
 Returns the position, in the catalog, of the table definition. More...
 
IlInt getTableDefsCount () const
 Returns the number of table definitions in the catalog. More...
 
IlBoolean insertTableDef (IlInt pos, IliSQLTableDef *def)
 Inserts a table definition in the catalog. More...
 
void read (IL_STDPREF istream &input)
 Reads the definition of the catalog from an input stream. More...
 
void removeTableDef (IlInt index, IlBoolean deleteIt=IlTrue)
 Removes the table definition from the catalog. More...
 
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. More...
 

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
displayThe display.

Member Function Documentation

IlInt IliSQLCatalog::appendTableDef ( IliSQLTableDef def)

Appends the table definition at the end of the catalog.

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

Parameters
defThe table definition.
Returns
The insertion position.
IlvDisplay* IliSQLCatalog::getDisplay ( ) const

Returns the display of the catalog.

Returns
The display of the catalog.
const IliSQLTableDef* IliSQLCatalog::getTableDef ( IlInt  p) const

Returns the table definition.

Parameters
pThe position.
Returns
The table definition.
IliSQLTableDef* IliSQLCatalog::getTableDef ( IlInt  p)

Returns the table definition.

Parameters
pThe position.
Returns
The table definition.
const IliSQLTableDef* IliSQLCatalog::getTableDef ( const IliSQLTableRef ref) const

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

Parameters
refThe table reference.
Returns
The table definition, or NULL if no such table definition is found.
IliSQLTableDef* IliSQLCatalog::getTableDef ( const IliSQLTableRef ref)

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

Parameters
refThe table reference.
Returns
The table definition, or NULL if no such table definition is found.
IlInt IliSQLCatalog::getTableDefIndex ( const IliSQLTableRef ref) const

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

Parameters
refThe table reference.
Returns
The position, or -1 if no such table definition is found.
IlInt IliSQLCatalog::getTableDefIndex ( const IliSQLTableDef tdef) const

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

Parameters
tdefThe table definition.
Returns
The position, in the catalog, of the table definition or -1 if it does not belong to the catalog.
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
posThe insertion position.
defThe table definition.
Returns
IlTrue if successful.
void IliSQLCatalog::read ( IL_STDPREF istream &  input)

Reads the definition of the catalog from an input stream.

Parameters
inputThe input stream.
void IliSQLCatalog::removeTableDef ( IlInt  index,
IlBoolean  deleteIt = IlTrue 
)

Removes the table definition from the catalog.

Parameters
indexThe table definition position.
deleteItIf 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
outputThe 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.