Class for a table as a view of another table. More...

#include <RefTable.h>

Inheritance diagram for casacore::RefTable:

Public Member Functions
	RefTable (BaseTable *, Bool rowOrder, rownr_t initialNrrow)
	Create a reference table object referencing the given BaseTable object. More...

	RefTable (BaseTable *, const Vector< rownr_t > &rowNumbers)
	A RefTable with the given row numbers is constructed. More...

	RefTable (BaseTable *, const Vector< Bool > &rowMask)
	Create a reference table object out of a mask. More...

	RefTable (BaseTable *, const Vector< String > &columnNames)
	Create a reference table object via projection (i.e. More...

	RefTable (AipsIO &, const String &name, rownr_t nrrow, int option, const TableLock &lockOptions, const TSMOption &tsmOption)
	Create a reference table out of a file (written by writeRefTable). More...

virtual	~RefTable ()
	The destructor flushes (i.e. More...

virtual void	reopenRW ()
	Try to reopen the table (the underlying one) for read/write access. More...

virtual Bool	asBigEndian () const
	Is the table stored in big or little endian format? More...

virtual const StorageOption &	storageOption () const
	Get the storage option used for the table. More...

virtual Bool	isMultiUsed (Bool checkSubTable) const
	Is the table in use (i.e. More...

virtual const TableLock &	lockOptions () const
	Get the locking info. More...

virtual void	mergeLock (const TableLock &lockOptions)
	Merge the given lock info with the existing one. More...

virtual Bool	hasLock (FileLocker::LockType) const
	Has this process the read or write lock, thus can the table be read or written safely? More...

virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Try to lock the table for read or write access. More...

virtual void	unlock ()
	Unlock the table. More...

virtual void	flush (Bool fsync, Bool recursive)
	Flush the table, i.e. More...

virtual void	resync ()
	Resync the Table object with the table file. More...

virtual uInt	getModifyCounter () const
	Get the modify counter. More...

virtual Bool	isWritable () const
	Test if the parent table is opened as writable. More...

void	getRef (AipsIO &, int option, const TableLock &lockOptions, const TSMOption &tsmOption)
	Read a reference table from a file. More...

virtual void	copy (const String &newName, int tableOption) const
	This is doing a shallow copy. More...

virtual void	deepCopy (const String &newName, const Record &dataManagerInfo, const StorageOption &, int tableOption, Bool, int endianFormat, Bool noRows) const
	Copy the table and all its subtables. More...

virtual int	tableType () const
	It returns the type of the parent table. More...

virtual TableDesc	actualTableDesc () const
	Get the actual table description. More...

virtual Record	dataManagerInfo () const
	Get the data manager info. More...

virtual TableRecord &	keywordSet ()
	Get readonly access to the table keyword set. More...

virtual TableRecord &	rwKeywordSet ()
	Get read/write access to the table keyword set. More...

virtual BaseColumn *	getColumn (uInt columnIndex) const
	Get a column object using its index. More...

virtual BaseColumn *	getColumn (const String &columnName) const
	Get a column object using its name. More...

virtual Bool	canRemoveRow () const
	Test if it is possible to remove a row from this table. More...

virtual void	removeRow (rownr_t rownr)
	Remove the given row. More...

virtual void	removeAllRow ()
	Remove the given row. More...

virtual void	addColumn (const ColumnDesc &columnDesc, Bool addToParent)
	Add one or more columns to the table. More...

virtual void	addColumn (const ColumnDesc &columnDesc, const String &dataManager, Bool byName, Bool addToParent)

virtual void	addColumn (const ColumnDesc &columnDesc, const DataManager &dataManager, Bool addToParent)

virtual void	addColumn (const TableDesc &tableDesc, const DataManager &dataManager, Bool addToParent)

virtual Bool	canRemoveColumn (const Vector< String > &columnNames) const
	Test if columns can be removed (yes). More...

virtual void	removeColumn (const Vector< String > &columnNames)
	Remove columns. More...

virtual Bool	canRenameColumn (const String &columnName) const
	Test if a column can be renamed (yes). More...

virtual void	renameColumn (const String &newName, const String &oldName)
	Rename a column. More...

virtual void	renameHypercolumn (const String &newName, const String &oldName)
	Rename a hypercolumn. More...

virtual DataManager *	findDataManager (const String &name, Bool byColumn) const
	Find the data manager with the given name or for the given column. More...

virtual Vector< rownr_t >	rowNumbers () const
	Get a vector of row numbers. More...

virtual BaseTable *	root ()
	Get parent of this table. More...

rownr_t	rootRownr (rownr_t rownr) const
	Get rownr in root table. More...

Vector< rownr_t >	rootRownr (const Vector< rownr_t > &rownrs) const
	Get vector of rownrs in root table. More...

virtual Bool	rowOrder () const
	Tell if the table is in row order. More...

virtual Vector< rownr_t > *	rowStorage ()
	Get row number vector. More...

void	addRownr (rownr_t rownr)
	Add a rownr to reference table. More...

void	addRownrRange (rownr_t startRownr, rownr_t endRownr)

void	setNrrow (rownr_t nrrow)
	Set the exact number of rows in the table. More...

virtual Bool	adjustRownrs (rownr_t nrrow, Vector< rownr_t > &rownrs, Bool determineOrder) const
	Adjust the row numbers to be the actual row numbers in the root table. More...

void	refAnd (rownr_t nr1, const rownr_t rows1, rownr_t nr2, const rownr_t rows2)
	And, or, subtract or xor the row numbers of 2 tables. More...

void	refOr (rownr_t nr1, const rownr_t rows1, rownr_t nr2, const rownr_t rows2)

void	refSub (rownr_t nr1, const rownr_t rows1, rownr_t nr2, const rownr_t rows2)

void	refXor (rownr_t nr1, const rownr_t rows1, rownr_t nr2, const rownr_t rows2)

void	refNot (rownr_t nr1, const rownr_t *rows1, rownr_t nrmain)

Public Member Functions inherited from casacore::BaseTable
	BaseTable (const String &tableName, int tableOption, rownr_t nrrow)
	Initialize the object. More...

	BaseTable (MPI_Comm mpiComm, const String &tableName, int tableOption, rownr_t nrrow)
	MPI version of the constructor. More...

void	BaseTableCommon (const String &tableName, int tableOption, rownr_t nrrow)
	Common code shared by the MPI constructor and non-MPI constructor. More...

virtual	~BaseTable ()

void	link ()
	Link to this BaseTable object (i.e. More...

virtual Bool	isNull () const
	Is the table a null table? By default it is not. More...

virtual void	setTableChanged ()
	Set the table to being changed. More...

void	doNotWrite ()
	Do not write the table (used in in case of exceptions). More...

Bool	isColumnWritable (const String &columnName) const
	Test if the given column is writable. More...

Bool	isColumnWritable (uInt columnIndex) const

Bool	isColumnStored (const String &columnName) const
	Test if the given column is stored (otherwise it is virtual). More...

Bool	isColumnStored (uInt columnIndex) const

const String &	tableName () const
	Get the table name. More...

virtual void	rename (const String &newName, int tableOption)
	Rename the table. More...

int	tableOption () const
	Get the table option. More...

void	markForDelete (Bool callback, const String &oldName)
	Mark the table for delete. More...

void	unmarkForDelete (Bool callback, const String &oldName)
	Unmark the table for delete. More...

Bool	isMarkedForDelete () const
	Test if the table is marked for delete. More...

const TableDesc &	tableDesc () const
	Get the table description. More...

void	showStructure (std::ostream &, Bool showDataMan, Bool showColumns, Bool showSubTables, Bool sortColumns, Bool cOrder)
	Show the table structure (implementation of Table::showStructure). More...

TableInfo &	tableInfo ()
	Get access to the TableInfo object. More...

virtual void	flushTableInfo ()
	Write the TableInfo object. More...

rownr_t	nrow () const
	Get number of rows. More...

virtual Bool	canAddRow () const
	Test if it is possible to add a row to this table. More...

virtual void	addRow (rownr_t nrrow=1, Bool initialize=True)
	Add one or more rows and possibly initialize them. More...

void	removeRow (const Vector< rownr_t > &rownrs)

void	removeRow (const Vector< uInt > &rownrs)

BaseTable *	select (const TableExprNode &, rownr_t maxRow, rownr_t offset)
	Select rows using the given expression (which can be null). More...

BaseTable *	select (rownr_t maxRow, rownr_t offset)
	Select maxRow rows and skip first offset rows. More...

BaseTable *	select (const Vector< rownr_t > &rownrs)
	Select rows using a vector of row numbers. More...

BaseTable *	select (const Block< Bool > &mask)
	Select rows using a mask block. More...

BaseTable *	project (const Block< String > &columnNames)
	Project the given columns (i.e. More...

BaseTable *	tabAnd (BaseTable *)
	Do logical operations on a table. More...

BaseTable *	tabOr (BaseTable *)
	union with another table More...

BaseTable *	tabSub (BaseTable *)
	subtract another table More...

BaseTable *	tabXor (BaseTable *)
	xor with another table More...

BaseTable *	tabNot ()
	take complement More...

BaseTable *	sort (const Block< String > &columnNames, const Block< CountedPtr< BaseCompare > > &compareObjects, const Block< Int > &sortOrder, int sortOption, std::shared_ptr< Vector< rownr_t >> sortIterBoundaries=nullptr, std::shared_ptr< Vector< size_t >> sortIterKeyIdxChange=nullptr)
	Sort a table on one or more columns of scalars. More...

BaseTableIterator *	makeIterator (const Block< String > &columnNames, const Block< CountedPtr< BaseCompare > > &, const Block< Int > &orders, int option, bool cacheIterationBoundaries=false)
	Create an iterator. More...

void	addColumns (const TableDesc &tableDesc, const Record &dmInfo, Bool addToParent)
	Add one or more columns to the table. More...

Bool	checkRemoveColumn (const Vector< String > &columnNames, Bool throwException) const
	Check if the set of columns can be removed. More...

virtual BaseTable *	doSort (PtrBlock< BaseColumn * > &, const Block< CountedPtr< BaseCompare > > &, const Block< Int > &sortOrder, int sortOption, std::shared_ptr< Vector< rownr_t >> sortIterBoundaries, std::shared_ptr< Vector< size_t >> sortIterKeyIdxChange)
	Do the actual sort. More...

RefTable *	makeRefTable (Bool rowOrder, rownr_t initialNrrow)
	Create a RefTable object. More...

void	checkRowNumber (rownr_t rownr) const
	Check if the row number is valid. More...

int	traceId () const
	Get the table's trace-id. More...

Static Public Member Functions
static void	getLayout (TableDesc &desc, AipsIO &ios)
	Return the layout of a table (i.e. More...

static rownr_t *	getStorage (Vector< rownr_t > &rownrs)
	Get the internal pointer in a rowStorage vector. More...

Static Public Member Functions inherited from casacore::BaseTable
static void	unlink (BaseTable *)
	Unlink from a BaseTable. More...

static TableInfo	tableInfo (const String &tableName)
	Get the table info of the table with the given name. More...

Private Member Functions
	RefTable (const RefTable &)
	Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result). More...

RefTable &	operator= (const RefTable &)
	Assignment is forbidden, because copying a table requires some more knowledge (like table name of result). More...

virtual void	getPartNames (Block< String > &names, Bool recursive) const
	Get the names of the tables this table consists of. More...

void	showStructureExtra (std::ostream &) const
	Show the extra table structure info (name of root table). More...

void	setup (BaseTable *btp, const Vector< String > &columnNames)
	Setup the main parts of the object. More...

void	makeRefCol ()
	Create the RefColumn objects for all columns in the description. More...

void	writeRefTable (Bool fsync)
	Write a reference table. More...

void	copyRefTable (const String &newName, int tableOption)
	Copy a RefTable that is not persistent. More...

Bool	checkAddColumn (const String &name, Bool addToParent)
	Check if a column can be added. More...

void	addRefCol (const ColumnDesc &cd)
	Add a column. More...

void	addRefCol (const TableDesc &tdesc)
	Add multiple columns. More...

Static Private Member Functions
static void	makeDesc (TableDesc &desc, const TableDesc &rootDesc, std::map< String, String > &nameMap, Vector< String > &names)
	Make a table description for the given columns. More...

Private Attributes
BaseTable *	baseTabPtr_p

Bool	rowOrd_p

Vector< rownr_t >	rowStorage_p

rownr_t *	rows_p

std::map< String, String >	nameMap_p

std::map< String, RefColumn * >	colMap_p

Bool	changed_p

Additional Inherited Members
Protected Member Functions inherited from casacore::BaseTable
void	scratchCallback (Bool isScratch, const String &oldName) const
	Do the callback for scratch tables (if callback is set). More...

Bool	makeTableDir ()
	Create the table directory when needed (and possible). More...

void	trueDeepCopy (const String &newName, const Record &dataManagerInfo, const StorageOption &, int tableOption, int endianFormat, Bool noRows) const
	Make a true deep copy of the table. More...

void	prepareCopyRename (const String &newName, int tableOption) const
	Prepare for copying or renaming a table. More...

virtual void	renameSubTables (const String &newName, const String &oldName)
	Rename the subtables (used by rename function). More...

void	throwIfTableExists ()
	Check if the table already exists. More...

Bool	openedForWrite () const
	Test if the table is opened for write. More...

void	writeStart (AipsIO &, Bool bigEndian)
	Start writing a table. More...

void	writeEnd (AipsIO &)
	End writing a table. More...

Bool	shouldNotWrite () const
	Should the table be written. More...

void	getTableInfo ()
	Read the TableInfo object. More...

Protected Attributes inherited from casacore::BaseTable
uInt	nrlink_p

rownr_t	nrrow_p

rownr_t	nrrowToAdd_p

CountedPtr< TableDesc >	tdescPtr_p

String	name_p

int	option_p

Bool	noWrite_p

Bool	delete_p

TableInfo	info_p

Bool	madeDir_p

int	itsTraceId

Detailed Description

Class for a table as a view of another table.

Intended use:

Internal

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Prerequisite

Etymology

RefTable represents a table which is a view on another table, thus which references another table.

Synopsis

RefTable is used to make a view on another table. Usually it is a view on a subset of the table, either in vertical or horizontal direction. Thus a subset of rows and/or columns. It will be the result of a select, sort, project or iterate function.

It acts to the user as a normal table. All gets and puts are handled by RefColumn which directs them to the referenced column while (if needed) converting the given row number to the row number in the referenced table. For that purpose RefTable maintains a Vector of the row numbers in the referenced table.

The RefTable constructor acts in a way that it will always reference the original table. This means that if a select is done on a RefTable, the resulting RefTable will also reference the original PlainTable. This is done to avoid long chains of RefTables. However, if ever some other kind of table views are introduced (like a join or a concatenation of similar tables), this cannot be used anymore. Most software already anticipates on that. The only exception is the code anding, oring tables (refAnd, etc.).

To Do

Maybe not allocating the row number vector for a projection. This saves space and time, but each rownr conversion will take a bit more time because it has to test if there is a vector.
Maybe maintain a Vector<String> telling on which columns the table is ordered. This may speed up selection, but it is hard to check if the order is changed by a put.
Allow to remove a row or column from the RefTable
Allow to rename a column in the RefTable
Maybe implement doSort one time for a more efficient sort. (now everything is handled by BaseTable).

Definition at line 104 of file RefTable.h.

Constructor & Destructor Documentation

casacore::RefTable::RefTable	(	BaseTable *	,
		Bool	rowOrder,
		rownr_t	initialNrrow
	)

Create a reference table object referencing the given BaseTable object.

If the BaseTable is actually another RefTable, it will reference its referenced table (thus the original table) and it will take its vector of row numbers and projected column names into account. Thus if a select is done on a projected table, the resulting RefTable will have the same projection.

Construct a RefTable with an empty row number vector. rowOrder=True indicates that the order of the rows will not be disturbed (as will be the case for a sort). A row number vector of the given size is initially allocated. Later this RefTable will be filled in by the select, etc..

casacore::RefTable::RefTable	(	BaseTable *	,
		const Vector< rownr_t > &	rowNumbers
	)

A RefTable with the given row numbers is constructed.

casacore::RefTable::RefTable	(	BaseTable *	,
		const Vector< Bool > &	rowMask
	)

Create a reference table object out of a mask.

The row number vector will consist of the rows for which the mask has a True value. The length of the mask must be the number of rows in the BaseTable.

casacore::RefTable::RefTable	(	BaseTable *	,
		const Vector< String > &	columnNames
	)

Create a reference table object via projection (i.e.

column selection). The row number vector is a copy of the given table.

casacore::RefTable::RefTable	(	AipsIO &	,
		const String &	name,
		rownr_t	nrrow,
		int	option,
		const TableLock &	lockOptions,
		const TSMOption &	tsmOption
	)

Create a reference table out of a file (written by writeRefTable).

The referenced table will also be created (if not stored in the cache).

virtual casacore::RefTable::~RefTable ( )

virtual

The destructor flushes (i.e.

writes) the table if it is opened for output and not marked for delete.

casacore::RefTable::RefTable ( const RefTable & )

private

Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result).

Declaring it private, makes it unusable.

Member Function Documentation

virtual TableDesc casacore::RefTable::actualTableDesc ( ) const

virtual

Get the actual table description.

void casacore::RefTable::addRownrRange	(	rownr_t	startRownr,
		rownr_t	endRownr
	)

void casacore::RefTable::getRef	(	AipsIO &	,
		int	option,
		const TableLock &	lockOptions,
		const TSMOption &	tsmOption
	)

void casacore::RefTable::refAnd	(	rownr_t	nr1,
		const rownr_t *	rows1,
		rownr_t	nr2,
		const rownr_t *	rows2
	)

void casacore::RefTable::refNot	(	rownr_t	nr1,
		const rownr_t *	rows1,
		rownr_t	nrmain
	)

void casacore::RefTable::refOr	(	rownr_t	nr1,
		const rownr_t *	rows1,
		rownr_t	nr2,
		const rownr_t *	rows2
	)

void casacore::RefTable::refSub	(	rownr_t	nr1,
		const rownr_t *	rows1,
		rownr_t	nr2,
		const rownr_t *	rows2
	)

void casacore::RefTable::refXor	(	rownr_t	nr1,
		const rownr_t *	rows1,
		rownr_t	nr2,
		const rownr_t *	rows2
	)

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members