casacore::ConcatTable Class Reference

Class to view a concatenation of tables as a single table. More...

#include <ConcatTable.h>

Inheritance diagram for casacore::ConcatTable:

Public Member Functions
	ConcatTable (const Block< BaseTable * > &tables, const Block< String > &subTables, const String &subDirName)
	Create a virtual table as the concatenation of the given tables.
	ConcatTable (const Block< String > &tableNames, const Block< String > &subTables, const String &subDirName, int option, const TableLock &lockOptions, const TSMOption &tsmOption)
	ConcatTable (AipsIO &, const String &name, uInt nrrow, int option, const TableLock &lockOptions, const TSMOption &tsmOption)
	Create a concat table out of a file (written by writeConcatTable).
virtual	~ConcatTable ()
	The destructor flushes (i.e.
virtual void	getPartNames (Block< String > &names, Bool recursive) const
	Get the names of the tables this table consists of.
virtual void	reopenRW ()
	Try to reopen the table (the underlying ones) for read/write access.
virtual Bool	asBigEndian () const
	Is the table stored in big or little endian format? It returns the endianness of the first underlying table.
virtual const StorageOption &	storageOption () const
	Get the storage option used for the table.
virtual Bool	isMultiUsed (Bool checkSubTable) const
	Is the table in use (i.e.
virtual const TableLock &	lockOptions () const
	Get the locking info.
virtual void	mergeLock (const TableLock &lockOptions)
	Merge the given lock info with the existing one.
virtual Bool	hasLock (FileLocker::LockType) const
	Has this process the read or write lock, thus can the table be read or written safely?
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Try to lock the table for read or write access.
virtual void	unlock ()
	Unlock the table.
virtual void	flush (Bool fsync, Bool recursive)
	Flush the table, i.e.
virtual void	resync ()
	Resync the Table object with the table files.
virtual uInt	getModifyCounter () const
	Get the modify counter.
virtual Bool	isWritable () const
	Test if all underlying tables are opened as writable.
void	getConcat (AipsIO &, int option, const TableLock &lockOptions, const TSMOption &tsmOption)
	Read a concat table from a file.
virtual void	copy (const String &newName, int tableOption) const
	This is doing a shallow copy.
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.
virtual int	tableType () const
	It returns the type of the parent table.
virtual TableDesc	actualTableDesc () const
	Get the actual table description.
virtual Record	dataManagerInfo () const
	Get the data manager info (of the first underlying table).
virtual TableRecord &	keywordSet ()
	Get readonly access to the table keyword set.
virtual TableRecord &	rwKeywordSet ()
	Get read/write access to the table keyword set.
virtual BaseColumn *	getColumn (uInt columnIndex) const
	Get a column object using its index.
virtual BaseColumn *	getColumn (const String &columnName) const
	Get a column object using its name.
virtual Bool	canRemoveRow () const
	Test if it is possible to remove a row from this table (no).
virtual void	removeRow (uInt rownr)
	Remove the given row.
virtual Bool	canRemoveColumn (const Vector< String > &columnNames) const
	Test if columns can be removed (no).
virtual void	addColumn (const ColumnDesc &columnDesc, Bool addToParent)
	Add one or more columns to the table.
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 void	removeColumn (const Vector< String > &columnNames)
	Remove a column.
virtual Bool	canRenameColumn (const String &columnName) const
	Test if a column can be renamed (no).
virtual void	renameColumn (const String &newName, const String &oldName)
	Rename a column.
virtual void	renameHypercolumn (const String &newName, const String &oldName)
	Rename a hypercolumn.
virtual DataManager *	findDataManager (const String &name, Bool byColumn) const
	Find the data manager with the given name or for the given column.
const ConcatRows &	rows () const
	Get the rows object.
Block< BaseColumn * >	getRefColumns (const String &columnName)
	Get the column objects in the referenced tables.
Table	asTable ()
	Create a (temporary) Table object from it.
Static Public Member Functions
static void	getLayout (TableDesc &desc, AipsIO &ios)
	Return the layout of a table (i.e.
Private Member Functions
	ConcatTable (const ConcatTable &)
	Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result).
ConcatTable &	operator= (const ConcatTable &)
	Assignment is forbidden, because copying a table requires some more knowledge (like table name of result).
void	showStructureExtra (std::ostream &) const
	Show the extra table structure info (names of used tables).
void	openTables (const Block< String > &tableNames, int option, const TableLock &lockOptions, const TSMOption &tsmOption)
	Open all tables in the required way.
void	initialize ()
	Initialize.
void	setup (BaseTable *btp, const Vector< String > &columnNames)
	Setup the main parts of the object.
void	addInfo ()
	Add lines containing the concatenated tables to the info.
void	makeConcatCol ()
	Create the ConcatColumn objects for all columns in the description.
void	handleSubTables ()
	Handle the subtales that have to be concatenated.
void	writeConcatTable (Bool fsync)
	Write a reference table.
void	checkAddColumn (const String &name, Bool addToParent)
	Check if the column can be added, thus does not exist yet.
Private Attributes
Block< String >	subTableNames_p
String	subDirName_p
Block< BaseTable * >	baseTabPtr_p
SimpleOrderedMap< String, ConcatColumn * >	colMap_p
TableRecord	keywordSet_p
Bool	changed_p
ConcatRows	rows_p

Detailed Description

Class to view a concatenation of tables as a single table.

Intended use:

Internal

Review Status

Reviewed By:: UNKNOWN

Prerequisite

Etymology

ConcatTable represents the concatenation of one or more tables.

Synopsis

ConcatTable is used to virtually concatenate one or more tables. Those tables must have the same description.

It acts to the user as a normal table. All gets and puts are handled by ConcatColumn which directs them to the referenced columns while (if needed) converting the given row number to the row number in the referenced tables. For that purpose ConcatTable keeps the number of rows in the referenced tables.
Note: Currently it cannot handle changes in the number of rows in the underlying tables;

It is possible to specify the keyword names of the subtables that have to be concatenated as well. The other subtables are assumed to be identical for all tables, so only the subtable of the first table is used.

The ConcatTable maintains its own keyword set, which is initially a copy of the keyword set of the first table. It replaces the keywords of the subtables to be concatenated. The keyword set is not persistent. One can add or change keywords, but these changes are not kept when the ConcatTable object is made persistent.

Motivation

Sometimes a very large MeasurementSet is split into multiple smaller ones using the time axis. Using ConcatTable they can still b viewed as a single MS. The SYSCAL subtable is split in time as well, thus it has to be possible to concatenate that one as well.
Note: An MS split in subband could be concatenated as well provided that at least the first part contains the full SPECTRAL_WINDOW subtable and that unique SPWids are used;

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 ConcatTable
Allow to rename a column in the ConcatTable
Maybe implement doSort one time for a more efficient sort. (now everything is handled by BaseTable).

Definition at line 118 of file ConcatTable.h.

Constructor & Destructor Documentation

casacore::ConcatTable::ConcatTable	(	const Block< BaseTable * > &	tables,
		const Block< String > &	subTables,
		const String &	subDirName
	)

Create a virtual table as the concatenation of the given tables.

It checks if the table descriptions of the tables are the same. Subtables with the given names will be concatenated as well. It is assumed that the other subtables are the same for all tables, so the ones of the first table are used.
The option can be Table::Old or Table::Update.
If a non-empty subdirectory name is given, the tables will be moved to that subdirectory when the concatenated table is written (by writeConcatTable).

casacore::ConcatTable::ConcatTable	(	const Block< String > &	tableNames,
		const Block< String > &	subTables,
		const String &	subDirName,
		int	option,
		const TableLock &	lockOptions,
		const TSMOption &	tsmOption
	)

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

Create a concat table out of a file (written by writeConcatTable).

The referenced tables will also be opened (if not stored in the cache).

virtual casacore::ConcatTable::~ConcatTable ( ) [virtual]

The destructor flushes (i.e.

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

casacore::ConcatTable::ConcatTable ( const ConcatTable & ) [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::ConcatTable::actualTableDesc ( ) const [virtual]

Get the actual table description.

virtual void casacore::ConcatTable::addColumn	(	const TableDesc &	tableDesc,
		const DataManager &	dataManager,
		Bool	addToParent
	)			`[virtual]`

virtual void casacore::ConcatTable::addColumn	(	const ColumnDesc &	columnDesc,
		const DataManager &	dataManager,
		Bool	addToParent
	)			`[virtual]`

void casacore::ConcatTable::checkAddColumn	(	const String &	name,
		Bool	addToParent
	)			`[private]`

virtual void casacore::ConcatTable::copy	(	const String &	newName,
		int	tableOption
	)			const `[virtual]`

virtual void casacore::ConcatTable::deepCopy	(	const String &	newName,
		const Record &	dataManagerInfo,
		const StorageOption &	,
		int	tableOption,
		Bool	,
		int	endianFormat,
		Bool	noRows
	)			const `[virtual]`

virtual DataManager* casacore::ConcatTable::findDataManager	(	const String &	name,
		Bool	byColumn
	)			const `[virtual]`

virtual void casacore::ConcatTable::flush	(	Bool	fsync,
		Bool	recursive
	)			`[virtual]`

void casacore::ConcatTable::getConcat	(	AipsIO &	,
		int	option,
		const TableLock &	lockOptions,
		const TSMOption &	tsmOption
	)

static void casacore::ConcatTable::getLayout	(	TableDesc &	desc,
		AipsIO &	ios
	)			`[static]`

virtual void casacore::ConcatTable::getPartNames	(	Block< String > &	names,
		Bool	recursive
	)			const `[virtual]`

virtual Bool casacore::ConcatTable::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)			`[virtual]`

void casacore::ConcatTable::openTables	(	const Block< String > &	tableNames,
		int	option,
		const TableLock &	lockOptions,
		const TSMOption &	tsmOption
	)			`[private]`

virtual void casacore::ConcatTable::renameColumn	(	const String &	newName,
		const String &	oldName
	)			`[virtual]`

void casacore::ConcatTable::setup	(	BaseTable *	btp,
		const Vector< String > &	columnNames
	)			`[private]`

casacore::ConcatTable Class Reference

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes