#include <ColumnSet.h>
Collaboration diagram for casa::ColumnSet:
Internal
ColumnSet represent the set of columns in a table.
ColumnSet contains all columns in a plain table (thus not in a RefTable). Furthermore it contains the set of data managers used by the columns in the table.
The main purpose of the class is to deal with constructing, writing and reading the column objects. It is used by classes SetupNewTable and Table.
Definition at line 90 of file ColumnSet.h.
Public Member Functions | |
| ColumnSet (TableDesc *) | |
| Construct from the table description. | |
| ~ColumnSet () | |
| void | reopenRW () |
| Reopen the data managers for read/write. | |
| void | renameTables (const String &newName, const String &oldName) |
| Rename the necessary subtables in the column keywords. | |
| Bool | areTablesMultiUsed () const |
| Are subtables used in other processes. | |
| PlainColumn * | getColumn (const String &columnName) const |
| Get a column by name. | |
| PlainColumn * | getColumn (uInt columnIndex) const |
| Get a column by index. | |
| void | addDataManager (DataManager *) |
| Add a data manager. | |
| void | initDataManagers (uInt nrrow, Bool bigEndian, Table &tab) |
| Initialize the data managers for a new table. | |
| void | linkToTable (BaseTable *baseTableObject) |
| Link the ColumnSet object to the BaseTable object. | |
| void | linkToLockObject (TableLockData *lockObject) |
| Link the ColumnSet object to the TableLockData object. | |
| void | autoReleaseLock () |
| Inspect the auto lock when the inspection interval has expired and release it when another process needs the lock. | |
| Bool | userLock (FileLocker::LockType, Bool wait) |
| If needed, get a temporary user lock. | |
| void | userUnlock (Bool releaseFlag) |
| Release a temporary user lock if the given release flag is True. | |
| Bool | canAddRow () const |
| Do all data managers and engines allow to add rows? | |
| Bool | canRemoveRow () const |
| Do all data managers and engines allow to remove rows? | |
| Bool | canRemoveColumn (const Vector< String > &columnNames) const |
| Can the given columns be removed from the data manager? | |
| Bool | canRenameColumn (const String &columnName) const |
| Can a column be renamed in the data manager? | |
| void | addRow (uInt nrrow) |
| Add rows to all data managers. | |
| void | removeRow (uInt rownr) |
| Remove a row from all data managers. | |
| void | removeColumn (const Vector< String > &columnNames) |
| Remove the columns from the map and the data manager. | |
| void | renameColumn (const String &newName, const String &oldName) |
| Rename the column in the map. | |
| uInt | nrow () const |
| Get nr of rows. | |
| TableDesc | actualTableDesc () const |
| Get the actual table description. | |
| Record | dataManagerInfo (Bool virtualOnly=False) const |
| Get the data manager info. | |
| void | initialize (uInt startRownr, uInt endRownr) |
| Initialize rows startRownr till endRownr (inclusive). | |
| Bool | putFile (Bool writeTable, AipsIO &, const TableAttr &, Bool fsync) |
| Write all the data and let the data managers flush their data. | |
| void | getFile (AipsIO &, Table &tab, uInt nrrow, Bool bigEndian) |
| Read the data, reconstruct the data managers, and link those to the table object. | |
| void | setTableChanged () |
| Set the table to being changed. | |
| Block< Bool > & | dataManChanged () |
| Get the data manager change flags (used by PlainTable). | |
| void | resync (uInt nrrow) |
| Synchronize the data managers when data in them have changed. | |
| void | invalidateColumnCaches () |
| Invalidate the column caches for all columns. | |
| DataManager * | getDataManager (uInt seqnr) const |
| Get the correct data manager. | |
| void | checkDataManagerNames () const |
| Check if no double data manager names have been given. | |
| DataManager * | findDataManager (const String &dataManagerName) const |
| Find the data manager with the given name. | |
| String | uniqueDataManagerName (const String &name) const |
| Make a unique data manager name by appending a suffix _n if needed where n is a number that makes the name unique. | |
| void | syncColumns (const ColumnSet &other, const TableAttr &defaultAttr) |
| Synchronize the columns after it appeared that data in the main table file have changed. | |
| void | checkReadLock (Bool wait) |
| Check if the table is locked for read or write. | |
| void | checkWriteLock (Bool wait) |
| void | addColumn (const ColumnDesc &columnDesc, Bool bigEndian, Table &tab) |
| Add a column to the table. | |
| void | addColumn (const ColumnDesc &columnDesc, const String &dataManager, Bool byName, Bool bigEndian, Table &tab) |
| void | addColumn (const ColumnDesc &columnDesc, const DataManager &dataManager, Bool bigEndian, Table &tab) |
| void | addColumn (const TableDesc &tableDesc, const DataManager &dataManager, Bool bigEndian, Table &tab) |
Private Member Functions | |
| void | removeLastDataManager () |
| Remove the last data manager (used by addColumn after an exception). | |
| void | initSomeDataManagers (uInt from, Table &tab) |
| Let the data managers (from the given index on) initialize themselves. | |
| void | prepareSomeDataManagers (uInt from) |
| Let the data managers (from the given index on) prepare themselves. | |
| Bool | checkDataManagerName (const String &name, uInt from, Bool doTthrow=True) const |
| Check if a data manager name has not already been used. | |
| void | doAddColumn (const ColumnDesc &columnDesc, DataManager *dataManPtr, Bool bigEndian) |
| Do the actual addition of a column. | |
| SimpleOrderedMap< void *, Int > | checkRemoveColumn (const Vector< String > &columnNames) |
| Check if columns to be removed can be removed. | |
| void | doLock (FileLocker::LockType, Bool wait) |
| Check if the table is locked for read or write. | |
Private Attributes | |
| TableDesc * | tdescPtr_p |
| uInt | nrrow_p |
| BaseTable * | baseTablePtr_p |
| TableLockData * | lockPtr_p |
| SimpleOrderedMap< String, void * > | colMap_p |
| uInt | seqCount_p |
| Block< void * > | blockDataMan_p |
| Block< Bool > | dataManChanged_p |
| casa::ColumnSet::ColumnSet | ( | TableDesc * | ) |
Construct from the table description.
This creates all underlying filled and virtual column objects.
| casa::ColumnSet::~ColumnSet | ( | ) |
| void casa::ColumnSet::reopenRW | ( | ) |
Reopen the data managers for read/write.
Rename the necessary subtables in the column keywords.
| Bool casa::ColumnSet::areTablesMultiUsed | ( | ) | const |
Are subtables used in other processes.
| PlainColumn* casa::ColumnSet::getColumn | ( | const String & | columnName | ) | const |
Get a column by name.
| PlainColumn* casa::ColumnSet::getColumn | ( | uInt | columnIndex | ) | const |
Get a column by index.
| void casa::ColumnSet::addDataManager | ( | DataManager * | ) |
Add a data manager.
It increments seqCount_p and returns that as a unique sequence number. This can, for instance, be used to create a unique file name.
Initialize the data managers for a new table.
It creates the data manager column objects for each column and it allows the data managers to link themselves to the Table object and to initialize themselves.
| void casa::ColumnSet::linkToTable | ( | BaseTable * | baseTableObject | ) | [inline] |
Link the ColumnSet object to the BaseTable object.
Definition at line 308 of file ColumnSet.h.
References baseTablePtr_p.
| void casa::ColumnSet::linkToLockObject | ( | TableLockData * | lockObject | ) | [inline] |
Link the ColumnSet object to the TableLockData object.
Definition at line 316 of file ColumnSet.h.
References lockPtr_p.
| void casa::ColumnSet::checkReadLock | ( | Bool | wait | ) | [inline] |
Check if the table is locked for read or write.
If manual or permanent locking is in effect, it checks if the table is properly locked. If autolocking is in effect, it locks the table when needed.
Definition at line 320 of file ColumnSet.h.
References doLock(), casa::TableLockData::hasLock(), lockPtr_p, casa::FileLocker::Read, and casa::TableLock::readLocking().
Referenced by casa::PlainColumn::checkReadLock().
| void casa::ColumnSet::checkWriteLock | ( | Bool | wait | ) | [inline] |
Definition at line 327 of file ColumnSet.h.
References doLock(), casa::TableLockData::hasLock(), lockPtr_p, and casa::FileLocker::Write.
Referenced by casa::PlainColumn::checkWriteLock().
| void casa::ColumnSet::autoReleaseLock | ( | ) | [inline] |
Inspect the auto lock when the inspection interval has expired and release it when another process needs the lock.
Definition at line 339 of file ColumnSet.h.
References casa::TableLockData::autoRelease(), and lockPtr_p.
Referenced by casa::PlainColumn::autoReleaseLock().
| Bool casa::ColumnSet::userLock | ( | FileLocker::LockType | , | |
| Bool | wait | |||
| ) |
If needed, get a temporary user lock.
It returns False if the lock was already there.
| void casa::ColumnSet::userUnlock | ( | Bool | releaseFlag | ) | [inline] |
Release a temporary user lock if the given release flag is True.
Definition at line 333 of file ColumnSet.h.
References lockPtr_p, and casa::TableLockData::release().
| Bool casa::ColumnSet::canAddRow | ( | ) | const |
Do all data managers and engines allow to add rows?
| Bool casa::ColumnSet::canRemoveRow | ( | ) | const |
Do all data managers and engines allow to remove rows?
Can the given columns be removed from the data manager?
Can a column be renamed in the data manager?
| void casa::ColumnSet::addRow | ( | uInt | nrrow | ) |
Add rows to all data managers.
| void casa::ColumnSet::removeRow | ( | uInt | rownr | ) |
Remove a row from all data managers.
It will throw an exception if not possible.
Remove the columns from the map and the data manager.
Rename the column in the map.
| void casa::ColumnSet::addColumn | ( | const ColumnDesc & | columnDesc, | |
| Bool | bigEndian, | |||
| Table & | tab | |||
| ) |
Add a column to the table.
The default implementation throws an "invalid operation" exception.
| void casa::ColumnSet::addColumn | ( | const ColumnDesc & | columnDesc, | |
| const String & | dataManager, | |||
| Bool | byName, | |||
| Bool | bigEndian, | |||
| Table & | tab | |||
| ) |
| void casa::ColumnSet::addColumn | ( | const ColumnDesc & | columnDesc, | |
| const DataManager & | dataManager, | |||
| Bool | bigEndian, | |||
| Table & | tab | |||
| ) |
| void casa::ColumnSet::addColumn | ( | const TableDesc & | tableDesc, | |
| const DataManager & | dataManager, | |||
| Bool | bigEndian, | |||
| Table & | tab | |||
| ) |
| uInt casa::ColumnSet::nrow | ( | ) | const [inline] |
| TableDesc casa::ColumnSet::actualTableDesc | ( | ) | const |
Get the actual table description.
Get the data manager info.
Optionally only the virtual engines are retrieved.
Initialize rows startRownr till endRownr (inclusive).
Write all the data and let the data managers flush their data.
This function is called when a table gets written (i.e. flushed). It returns True if any data manager wrote something.
Read the data, reconstruct the data managers, and link those to the table object.
This function gets called when an existing table is read back.
| void casa::ColumnSet::setTableChanged | ( | ) | [inline] |
Set the table to being changed.
Definition at line 312 of file ColumnSet.h.
References baseTablePtr_p, and casa::BaseTable::setTableChanged().
Get the data manager change flags (used by PlainTable).
Definition at line 343 of file ColumnSet.h.
References dataManChanged_p.
| void casa::ColumnSet::resync | ( | uInt | nrrow | ) |
Synchronize the data managers when data in them have changed.
| void casa::ColumnSet::invalidateColumnCaches | ( | ) |
Invalidate the column caches for all columns.
| DataManager* casa::ColumnSet::getDataManager | ( | uInt | seqnr | ) | const |
Get the correct data manager.
This is used by the column objects to link themselves to the correct datamanagers when they are read back.
| void casa::ColumnSet::checkDataManagerNames | ( | ) | const |
Check if no double data manager names have been given.
| DataManager* casa::ColumnSet::findDataManager | ( | const String & | dataManagerName | ) | const |
Find the data manager with the given name.
When the data manager is unknown, an exception is thrown. A blank name means the data manager is unknown.
Make a unique data manager name by appending a suffix _n if needed where n is a number that makes the name unique.
Synchronize the columns after it appeared that data in the main table file have changed.
It cannot deal with changes in number of columns, so it throws an exception when they have changed. Keywords in all columns are updated. The other ColumnSet gives the new data.
| void casa::ColumnSet::removeLastDataManager | ( | ) | [private] |
Remove the last data manager (used by addColumn after an exception).
It does the opposite of addDataManager.
Let the data managers (from the given index on) initialize themselves.
| void casa::ColumnSet::prepareSomeDataManagers | ( | uInt | from | ) | [private] |
Let the data managers (from the given index on) prepare themselves.
| Bool casa::ColumnSet::checkDataManagerName | ( | const String & | name, | |
| uInt | from, | |||
| Bool | doTthrow = True | |||
| ) | const [private] |
Check if a data manager name has not already been used.
Start checking at the given index in the array. It returns False if the name has already been used. By default an exception is thrown if the name has already been used.
| void casa::ColumnSet::doAddColumn | ( | const ColumnDesc & | columnDesc, | |
| DataManager * | dataManPtr, | |||
| Bool | bigEndian | |||
| ) | [private] |
Do the actual addition of a column.
| SimpleOrderedMap<void*,Int> casa::ColumnSet::checkRemoveColumn | ( | const Vector< String > & | columnNames | ) | [private] |
Check if columns to be removed can be removed.
It returns a map of DataManager* telling how many columns for a data manager have to be removed. A count of -1 means that all columns have to be removed. For such columns the flag in the returned Block is False, otherwise True.
| void casa::ColumnSet::doLock | ( | FileLocker::LockType | , | |
| Bool | wait | |||
| ) | [private] |
Check if the table is locked for read or write.
If manual or permanent locking is in effect, it checks if the table is properly locked. If autolocking is in effect, it locks the table when needed.
Referenced by checkReadLock(), and checkWriteLock().
TableDesc* casa::ColumnSet::tdescPtr_p [private] |
Definition at line 291 of file ColumnSet.h.
uInt casa::ColumnSet::nrrow_p [private] |
BaseTable* casa::ColumnSet::baseTablePtr_p [private] |
TableLockData* casa::ColumnSet::lockPtr_p [private] |
Definition at line 294 of file ColumnSet.h.
Referenced by autoReleaseLock(), checkReadLock(), checkWriteLock(), linkToLockObject(), and userUnlock().
SimpleOrderedMap<String,void*> casa::ColumnSet::colMap_p [private] |
Definition at line 295 of file ColumnSet.h.
uInt casa::ColumnSet::seqCount_p [private] |
Definition at line 296 of file ColumnSet.h.
Block<void*> casa::ColumnSet::blockDataMan_p [private] |
Definition at line 298 of file ColumnSet.h.
Block<Bool> casa::ColumnSet::dataManChanged_p [private] |
1.5.1