Read/write access to a table row. More...

#include <TableRow.h>

Inheritance diagram for casacore::TableRow:

Public Member Functions
	TableRow ()
	Create a detached TableRow object. More...

	TableRow (const Table &table, Bool storedColumnsOnly=True)
	Create a TableRow object for the given Table. More...

	TableRow (const Table &table, const Vector< String > &columnNames, Bool exclude=False)
	Create a TableRow object for the given Table. More...

	TableRow (const TableRow &)
	Copy constructor (copy semantics). More...

	~TableRow ()

TableRow &	operator= (const TableRow &)
	Assignment (copy semantics). More...

TableRecord &	record ()
	Get non-const access to the TableRecord in this object. More...

void	put ()
	Put into the last row read. More...

void	put (rownr_t rownr)
	Put into the given row. More...

void	put (rownr_t rownr, const TableRecord &record, Bool checkConformance=True)
	Put the values found in the TableRecord in the appropriate columns in the given row. More...

void	put (rownr_t rownr, const TableRecord &record, const Block< Bool > &valuesDefined, Bool checkConformance=True)

void	putMatchingFields (rownr_t rownr, const TableRecord &record)
	Put the values found in the TableRecord. More...

Public Member Functions inherited from casacore::ROTableRow
	ROTableRow ()
	Create a detached ROTableRow object. More...

	ROTableRow (const Table &table, Bool storedColumnsOnly=True)
	Create a ROTableRow object for the given Table. More...

	ROTableRow (const Table &table, const Vector< String > &columnNames, Bool exclude=False)
	Create a ROTableRow object for the given Table. More...

	ROTableRow (const ROTableRow &)
	Copy constructor (copy semantics). More...

	~ROTableRow ()

ROTableRow &	operator= (const ROTableRow &)
	Assignment (copy semantics). More...

Bool	isAttached () const
	Test if a Table is attached to this object. More...

const Table &	table () const
	Get the Table used for this object. More...

const TableRecord &	record () const
	Get the record containing all fields. More...

Int64	rowNumber () const
	Get the number of the last row read. More...

Vector< String >	columnNames () const
	Get a vector consisting of all columns names. More...

const TableRecord &	get (rownr_t rownr, Bool alwaysRead=False) const
	Get the values of all columns used from the given row. More...

const Block< Bool > &	getDefined () const
	Get the block telling for each column if its value in the row was indefined in the table. More...

Private Member Functions
Bool	namesConform (const TableRecord &that) const
	Check if the names of the given record match this row. More...

Additional Inherited Members
Protected Member Functions inherited from casacore::ROTableRow
void	copy (const ROTableRow &that)
	Copy that object to this object. More...

void	create (const Table &table, Bool storedColumnsOnly, Bool writable)
	Create the record, column, and field objects for all columns in the table. More...

void	create (const Table &table, const Vector< String > &columnNames, Bool exclude, Bool writable)
	Create the record, column, and field objects for the given columns. More...

void	putRecord (rownr_t rownr)
	Put the values found in the internal TableRecord at the given row. More...

void	putField (rownr_t rownr, const TableRecord &record, Int whichColumn, Int whichField)
	Put a value in the given field in the TableRecord into the given row and column. More...

void	setReread (rownr_t rownr)
	Set the switch to reread when the current row has been put. More...

Protected Attributes inherited from casacore::ROTableRow
TableRecord *	itsRecord

Table	itsTable

Block< void * >	itsTabCols

Block< void * >	itsColumns

Block< void * >	itsFields

Block< Bool >	itsDefined

uInt	itsNrused

Int64	itsLastRow

Bool	itsReread

Detailed Description

Read/write access to a table row.

Intended use:

Public interface

Review Status

Reviewed By:: Paul Shannon
Date Reviewed:: 1995/05/10
Test programs:: tTableRow

Prerequisite

ROTableRow

Synopsis

The class TableRow is derived from ROTableRow and as an extra it provides write-access to a row in a table. With the put function, all values in the TableRecord object will be put in the corresponding columns in the table row. There is, however, an extra consideration:

Constructing a TableRow object fails if the table is not writable. Non-writable columns will not be part of the object. If an explicitly given column is non-writable, the construction will also fail.

There are effectively 3 ways of writing data.

The function
put (rownr, tableRecord);

can be used to put all values from the given TableRecord, which has to be conforming (i.e. matching order and names). Optionally the conformance is checked. This put function is capable of data type promotion. For instance, if column COL1 is float, the corresponding field in the TableRecord can be Int.
A faster way is using the functions record and put. It is possible to use RecordFieldPtr objects to get direct access to the fields in the record (provided the structure of the record is known). E.g.
TableRow row (someTable, stringToVector("col1,col2,col3"));

RecordFieldPtr<String> col1(row.record(), "col1");

RecordFieldPtr<double> col2(row.record(), "col2");

RecordFieldPtr<Array<Int> > col3(row.record(), "col3");

for (rownr_t i=0; i<n; i++) {

*col1 = someString;

*col2 = somedouble;

*col3 = someArrayInt;

row.put (i);

}
The function
putMatchingFields (rownr, tableRecord);

can be used to put some fields from the given TableRecord. Only fields having a corresponding name in the TableRow object will be put. Similar to the first way data type promotion will be applied for numeric values.
E.g.: Suppose the TableRow object has columns A, C, and B, and the given TableRecord has fields B, D, and C. Only fields B and C will be put. As the example shows, the order of the fields is not important.
This way is (much) slower than the other 2, because a name lookup is involved for each field. It can, however, be more convenient to use.

Example

// Open the new table (with 10 rows) and define a row object containing
// values from the given column.
// Note that the function stringToVector is a very convenient
// way to construct a Vector<String>.
SetupNewTable newtab(tableDesc, Table::new);
Table table(newtab, 10);
TableRow row (table, stringToVector("col1,col2,col3,col4"));
// Loop through all rows and get their values.
for (rownr_t i=0; i<table.nrow(); i++) {
// Some magic filler function returns a filled TableRecord
// (with the correct fields in the correct order).
TableRecord record = fillerFunction();
row.put (i, record);
}

Definition at line 389 of file TableRow.h.

Constructor & Destructor Documentation

casacore::TableRow::TableRow ( )

Create a detached TableRow object.

This means that no Table, etc. is contained in it. Function isAttached (in the base class) will return False for it.
This constructor should normally not be used, because it does not result in a valid object. It should only be used when really needed (e.g. when an array of objects has to be used).

casacore::TableRow::TableRow	(	const Table &	table,
		Bool	storedColumnsOnly = `True`
	)

explicit

Create a TableRow object for the given Table.

Its TableRecord will contain all columns except columns with datatype TpOther and columns which are not writable.
If the flag storedColumnsOnly is True, only the columns actually stored by a storage manager will be selected. This is useful when the contents of an entire row have to be copied. Virtual columns are calculated on-the-fly (often using stored columns), thus it makes no sense to copy their data.
Caution: If the table contains columns with large arrays, it may be better not to use this constructor; Each get will read in all data in the row, thus also the large data array(s); In that case it is better to use the next constructor which works selectively;

casacore::TableRow::TableRow	(	const Table &	table,
		const Vector< String > &	columnNames,
		Bool	exclude = `False`
	)

Create a TableRow object for the given Table.

Its TableRecord will contain all columns given in the Vector. An exception is thrown if an unknown column name is given or if a column is given which is not writable.
When exclude=True, all columns except the given columns are taken. In that case an unknown name does not result in an exception and non-writable columns are simply skipped.

casacore::TableRow::TableRow ( const TableRow & )

Copy constructor (copy semantics).

casacore::TableRow::~TableRow ( )

Member Function Documentation

Bool casacore::TableRow::namesConform ( const TableRecord & that ) const

private

Check if the names of the given record match this row.

TableRow& casacore::TableRow::operator= ( const TableRow & )

Assignment (copy semantics).

void casacore::TableRow::put ( )

Put into the last row read.

An exception is thrown if no row has been read yet. The values in the TableRecord contained in this object are put. This TableRecord can be accessed and updated using the function record.

void casacore::TableRow::put ( rownr_t rownr )

inline

Put into the given row.

The values in the TableRecord contained in this object are put. This TableRecord can be accessed and updated using the function record.

Definition at line 521 of file TableRow.h.

References casacore::ROTableRow::putRecord().

void casacore::TableRow::put	(	rownr_t	rownr,
		const TableRecord &	record,
		Bool	checkConformance = `True`
	)

Put the values found in the TableRecord in the appropriate columns in the given row.

The names and order of the fields in the TableRecord must conform those of the description of the TableRow. The data types of numeric values do not need to conform exactly; they can be promoted (e.g. an Int value in the record may correspond to a float column). If not conforming, an exception is thrown.
Note: For performance reasons it is optional to check the name order conformance;
The valuesDefined block tells if the value in the corresponding field in the record is actually defined. If not, nothing will be written. It is meant for array values which might be undefined in a table.

void casacore::TableRow::put	(	rownr_t	rownr,
		const TableRecord &	record,
		const Block< Bool > &	valuesDefined,
		Bool	checkConformance = `True`
	)

void casacore::TableRow::putMatchingFields	(	rownr_t	rownr,
		const TableRecord &	record
	)

Put the values found in the TableRecord.

Only fields with a matching name in the TableRow object will be put. This makes it possible to put fields in a selective way.
E.g.: If the TableRow contains columns A and B, and the record contains fields B and C, only field B will be put.
In principle the data types of the matching fields must match, but data type promotion of numeric values will be applied.

TableRecord & casacore::TableRow::record ( )

inline

Get non-const access to the TableRecord in this object.

This can be used to change values in it which can thereafter be put using the function put(rownr).
Note: The returned TableRecord has a fixed structure, so it is not possible to add or remove fields; It is only possible to change values;

Definition at line 517 of file TableRow.h.

References casacore::ROTableRow::itsRecord.

The documentation for this class was generated from the following file:

tables/Tables/TableRow.h

Public Member Functions

Private Member Functions

Additional Inherited Members