IliTableBuffer Class Reference

Table class. More...

#include <ilviews/dataccess/tblbuf.h>

Inheritance diagram for IliTableBuffer:

List of all members.

Public Member Functions
const IliValue &	at (IliName colname) const
	Returns a value.
const IliValue &	at (IlInt colno) const
	Returns a value.
IliValue &	at (IliName colname)
	Returns a value.
IliValue &	at (IlInt colno)
	Returns a value.
void	clear ()
	Sets all values in the table buffer to the null value.
IlInt	count () const
	Returns the number of values in the table buffer.
IliTable *	getTable () const
	Returns the table from which the table buffer has been obtained.
IlBoolean	isModified () const
	Returns IlTrue if a value in the table buffer has been modified.
IlBoolean	isNull () const
	Returns IlTrue if all the values in the table buffer are null.
const IliValue &	operator[] (IliName colname) const
	Returns a value.
const IliValue &	operator[] (IlInt volno) const
	Returns a value.
IliValue &	operator[] (IliName colname)
	Returns a value.
IliValue &	operator[] (IlInt colno)
	Returns a value.
IlBoolean	rowToBuffer (IlInt rowno)
	Retrieves a row from the underlying table.
Friends
class	IliTable

---

Detailed Description

Table class.

Library: dataccess

The IliTableBuffer class works in conjunction with the IliTable class. It is required by the users of a table object, to inspect, alter, or insert new rows into the table. An IliTableBuffer object can be obtained using the IliTable::getBuffer member function. It can then be used to retrieve rows from the table, to update, or insert new rows into the table. When it is no longer required, it should be returned to the table using the IliTable::releaseBuffer member function.

See also:

IliName, IliTable, IliValue

---

Member Function Documentation

const IliValue& IliTableBuffer::at

(

IliName

colname

)

const

Returns a value.

Parameters:

colname

The column name.

Returns:

A constant reference to the value that corresponds to the column named colname.

const IliValue& IliTableBuffer::at

(

IlInt

colno

)

const

Returns a value.

Parameters:

colno

The column position.

Returns:

A constant reference to the value positioned at colno.

IliValue& IliTableBuffer::at

(

IliName

colname

)

Returns a value.

Parameters:

colname

The column name.

Returns:

A reference to the value that corresponds to the column named colname.

IliValue& IliTableBuffer::at

(

IlInt

colno

)

Returns a value.

Parameters:

colno

The column position.

Returns:

A reference to the value positioned at colno.

void IliTableBuffer::clear

(

)

Sets all values in the table buffer to the null value.

In addition, the modified property of the table buffer is cleared.

IlInt IliTableBuffer::count

(

)

const

Returns the number of values in the table buffer.

Each of these values corresponds to a column in the underlying table.

Returns:

The count.

IliTable * IliTableBuffer::getTable

(

)

const

Returns the table from which the table buffer has been obtained.

Returns:

The table.

IlBoolean IliTableBuffer::isModified

(

)

const

Returns IlTrue if a value in the table buffer has been modified.

Returns:

IlTrue if a value in the table buffer has been modified since the last time either of the clear or rowToBuffer member functions was called.

IlBoolean IliTableBuffer::isNull

(

)

const

Returns IlTrue if all the values in the table buffer are null.

Returns:

IlTrue if all the values in the table buffer are null.

const IliValue & IliTableBuffer::operator[]

(

IliName

colname

)

const

Returns a value.

Parameters:

colname

The column name.

Returns:

A constant reference to the value corresponding to the column named colname.

const IliValue & IliTableBuffer::operator[]

(

IlInt

volno

)

const

Returns a value.

Parameters:

colno

The column position.

Returns:

A constant reference to the value positioned at colno.

IliValue & IliTableBuffer::operator[]

(

IliName

colname

)

Returns a value.

Parameters:

colname

The column name.

Returns:

A reference to the value corresponding to the column named colname.

IliValue & IliTableBuffer::operator[]

(

IlInt

colno

)

Returns a value.

Parameters:

colno

The column position.

Returns:

A reference to the value positioned at colno.

IlBoolean IliTableBuffer::rowToBuffer

(

IlInt

rowno

)

Retrieves a row from the underlying table.

After this member function has been called, each value in the table buffer is the same as its corresponding value in the designated row. In addition, the modified property of the table buffer is cleared.

Parameters:

rowno

The row position.

Returns:

IlTrue if successful.