BaseColumn.h

Classes

BaseColumn -- Abstract base class for a table column (full description)

class BaseColumn

Interface

Public Members

BaseColumn (const BaseColumnDesc*)

virtual ~BaseColumn()

virtual Bool isWritable() const = 0

virtual Bool isStored() const = 0

virtual TableRecord& rwKeywordSet() = 0

virtual TableRecord& keywordSet() = 0

const ColumnDesc& columnDesc() const

virtual uInt nrow() const = 0

virtual Bool isDefined (uInt rownr) const = 0

virtual void setShape (uInt rownr, const IPosition& shape)

virtual void setShape (uInt rownr, const IPosition& shape, const IPosition& tileShape)

virtual uInt ndimColumn() const

virtual IPosition shapeColumn() const

virtual uInt ndim (uInt rownr) const

virtual IPosition shape (uInt rownr) const

virtual Bool canChangeShape() const

virtual Bool canAccessScalarColumn (Bool& reask) const

virtual Bool canAccessArrayColumn (Bool& reask) const

virtual Bool canAccessScalarColumnCells (Bool& reask) const

virtual Bool canAccessArrayColumnCells (Bool& reask) const

virtual Bool canAccessSlice (Bool& reask) const

virtual Bool canAccessColumnSlice (Bool& reask) const

virtual void initialize (uInt startRownr, uInt endRownr) = 0

virtual void get (uInt rownr, void* dataPtr) const = 0

virtual void getSlice (uInt rownr, const Slicer&, void* dataPtr) const

virtual void getScalarColumn (void* dataPtr) const

virtual void getArrayColumn (void* dataPtr) const

virtual void getColumnSlice (const Slicer&, void* dataPtr) const

virtual void getScalarColumnCells (const RefRows& rownrs, void* dataPtr) const

virtual void getArrayColumnCells (const RefRows& rownrs, void* dataPtr) const

virtual void getColumnSliceCells (const RefRows& rownrs, const Slicer&, void* dataPtr) const

virtual void put (uInt rownr, const void* dataPtr) = 0

virtual void putSlice (uInt rownr, const Slicer&, const void* dataPtr)

virtual void putScalarColumn (const void* dataPtr)

virtual void putArrayColumn (const void* dataPtr)

virtual void putColumnSlice (const Slicer&, const void* dataPtr)

virtual void putScalarColumnCells (const RefRows& rownrs, const void* dataPtr)

virtual void putArrayColumnCells (const RefRows& rownrs, const void* dataPtr)

virtual void putColumnSliceCells (const RefRows& rownrs, const Slicer&, const void* dataPtr)

void getScalar (uInt rownr, Bool& value) const

void getScalar (uInt rownr, uChar& value) const

void getScalar (uInt rownr, Short& value) const

void getScalar (uInt rownr, uShort& value) const

void getScalar (uInt rownr, Int& value) const

void getScalar (uInt rownr, uInt& value) const

void getScalar (uInt rownr, float& value) const

void getScalar (uInt rownr, double& value) const

void getScalar (uInt rownr, Complex& value) const

void getScalar (uInt rownr, DComplex& value) const

void getScalar (uInt rownr, String& value) const

void getScalar (uInt rownr, TableRecord& value) const

void getScalar (uInt rownr, void* value, const String& dataTypeId) const

void putScalar (uInt rownr, const Bool& value)

void putScalar (uInt rownr, const uChar& value)

void putScalar (uInt rownr, const Short& value)

void putScalar (uInt rownr, const uShort& value)

void putScalar (uInt rownr, const Int& value)

void putScalar (uInt rownr, const uInt& value)

void putScalar (uInt rownr, const float& value)

void putScalar (uInt rownr, const double& value)

void putScalar (uInt rownr, const Complex& value)

void putScalar (uInt rownr, const DComplex& value)

void putScalar (uInt rownr, const String& value)

void putScalar (uInt rownr, const Char* value)

void putScalar (uInt rownr, const TableRecord& value)

virtual ColumnCache& columnCache() = 0

virtual void setMaximumCacheSize (uInt nbytes) = 0

virtual void makeSortKey (Sort&, ObjCompareFunc* cmpFunc, Int order, const void*& dataSave)

virtual void makeRefSortKey (Sort&, ObjCompareFunc* cmpFunc, Int order, const Vector<uInt>& rownrs, const void*& dataSave)

virtual void freeSortKey (const void*& dataSave)

virtual void allocIterBuf (void*& lastVal, void*& curVal, ObjCompareFunc*& cmpFunc)

virtual void freeIterBuf (void*& lastVal, void*& curVal)

Description

Review Status

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

Prerequisite

ColumnDesc
Table

Etymology

This is the (abstract) base class to access a column in a table.

Synopsis

This class is the base class for the derived column classes. It is a private class in the sense that the user cannot get access to it. All user access to a column is done via the classes TableColumn, ScalarColumn and ArrayColumn. They call the corresponding functions in this class and its derived classes.

Motivation

This class serves a the base for the more specialized column classes like FilledScalarColumn and RefColumn. It defines many virtual functions, which are implemented in the derived classes. Some of these functions are purely virtual, some have a default implementation throwing an "invalid operation" exception. In that way those latter functions only have to be implemented in the classes which handle those cases.

The class RefColumn is in fact implemented in terms of this class. Almost every function in RefColumn calls the corresponding function in BaseColumn with the correct row number.

To Do

Member Description

BaseColumn (const BaseColumnDesc*)

Construct it using the given column description.

virtual ~BaseColumn()

virtual Bool isWritable() const = 0

Test if the column is writable.

virtual Bool isStored() const = 0

Test if the column is stored (otherwise it is virtual).

virtual TableRecord& rwKeywordSet() = 0
virtual TableRecord& keywordSet() = 0

Get access to the column keyword set.

const ColumnDesc& columnDesc() const

Get const access to the column description.

virtual uInt nrow() const = 0

Get nr of rows in the column.

virtual Bool isDefined (uInt rownr) const = 0

Test if the given cell contains a defined value.

virtual void setShape (uInt rownr, const IPosition& shape)

Set the shape of the array in the given row.

virtual void setShape (uInt rownr, const IPosition& shape, const IPosition& tileShape)

Set the shape and tile shape of the array in the given row.

virtual uInt ndimColumn() const

Get the global #dimensions of an array (ie. for all rows).

virtual IPosition shapeColumn() const

Get the global shape of an array (ie. for all rows).

virtual uInt ndim (uInt rownr) const

Get the #dimensions of an array in a particular cell.

virtual IPosition shape (uInt rownr) const

Get the shape of an array in a particular cell.

virtual Bool canChangeShape() const

Ask the data manager if the shape of an existing array can be changed. Default is no.

virtual Bool canAccessScalarColumn (Bool& reask) const

Ask if the data manager can handle a scalar column. Default is never.

virtual Bool canAccessArrayColumn (Bool& reask) const

Ask if the data manager can handle an array column. Default is never.

virtual Bool canAccessScalarColumnCells (Bool& reask) const

Ask if the data manager can handle a collection of cells in a scalar column. Default is never.

virtual Bool canAccessArrayColumnCells (Bool& reask) const

Ask if the data manager can handle a collection of cells in an array column. Default is never.

virtual Bool canAccessSlice (Bool& reask) const

Ask if the data manager can handle a cell slice. Default is never.

virtual Bool canAccessColumnSlice (Bool& reask) const

Ask if the data manager can handle a column slice. Default is never.

virtual void initialize (uInt startRownr, uInt endRownr) = 0

Initialize the rows from startRow till endRow (inclusive) with the default value defined in the column description.

virtual void get (uInt rownr, void* dataPtr) const = 0

Get the value from a particular cell. This can be a scalar or an array.

virtual void getSlice (uInt rownr, const Slicer&, void* dataPtr) const

Get a slice of an N-dimensional array in a particular cell.

virtual void getScalarColumn (void* dataPtr) const

Get the vector of all scalar values in a column.

virtual void getArrayColumn (void* dataPtr) const

Get the array of all array values in a column. If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void getColumnSlice (const Slicer&, void* dataPtr) const

Get subsections from all arrays in the column. If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void getScalarColumnCells (const RefRows& rownrs, void* dataPtr) const

Get the vector of some scalar values in a column.

virtual void getArrayColumnCells (const RefRows& rownrs, void* dataPtr) const

Get the array of some array values in a column. If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void getColumnSliceCells (const RefRows& rownrs, const Slicer&, void* dataPtr) const

Get subsections from some arrays in the column. If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void put (uInt rownr, const void* dataPtr) = 0

Put the value in a particular cell. This can be a scalar or an array.

virtual void putSlice (uInt rownr, const Slicer&, const void* dataPtr)

Put a slice of an N-dimensional array in a particular cell.

virtual void putScalarColumn (const void* dataPtr)

Put the vector of all scalar values in the column.

virtual void putArrayColumn (const void* dataPtr)

Put the array of all array values in the column. If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void putColumnSlice (const Slicer&, const void* dataPtr)

Put into subsections of all table arrays in the column. If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void putScalarColumnCells (const RefRows& rownrs, const void* dataPtr)

Get the vector of some scalar values in a column.

virtual void putArrayColumnCells (const RefRows& rownrs, const void* dataPtr)

Get the array of some array values in a column. If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

virtual void putColumnSliceCells (const RefRows& rownrs, const Slicer&, const void* dataPtr)

Put subsections of some arrays in the column. If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

void getScalar (uInt rownr, Bool& value) const
void getScalar (uInt rownr, uChar& value) const
void getScalar (uInt rownr, Short& value) const
void getScalar (uInt rownr, uShort& value) const
void getScalar (uInt rownr, Int& value) const
void getScalar (uInt rownr, uInt& value) const
void getScalar (uInt rownr, float& value) const
void getScalar (uInt rownr, double& value) const
void getScalar (uInt rownr, Complex& value) const
void getScalar (uInt rownr, DComplex& value) const
void getScalar (uInt rownr, String& value) const
void getScalar (uInt rownr, TableRecord& value) const

Get the value from the row and convert it to the required type. This can only be used for scalar columns with a standard data type.

void getScalar (uInt rownr, void* value, const String& dataTypeId) const

Get a scalar for the other data types. The given data type id must match the data type id of this column.

void putScalar (uInt rownr, const Bool& value)
void putScalar (uInt rownr, const uChar& value)
void putScalar (uInt rownr, const Short& value)
void putScalar (uInt rownr, const uShort& value)
void putScalar (uInt rownr, const Int& value)
void putScalar (uInt rownr, const uInt& value)
void putScalar (uInt rownr, const float& value)
void putScalar (uInt rownr, const double& value)
void putScalar (uInt rownr, const Complex& value)
void putScalar (uInt rownr, const DComplex& value)
void putScalar (uInt rownr, const String& value)
void putScalar (uInt rownr, const Char* value)
void putScalar (uInt rownr, const TableRecord& value)

Put the value into the row and convert it from the given type. This can only be used for scalar columns with a standard data type.

virtual ColumnCache& columnCache() = 0

Get a pointer to the underlying column cache.

virtual void setMaximumCacheSize (uInt nbytes) = 0

Set the maximum cache size (in bytes) to be used by a storage manager.

virtual void makeRefSortKey (Sort&, ObjCompareFunc* cmpFunc, Int order, const Vector<uInt>& rownrs, const void*& dataSave)

Add this column and its data to the Sort object. It may allocate some storage on the heap, which will be saved in the argument dataSave. The function freeSortKey must be called to free this storage.

Do it only for the given row numbers.

virtual void makeSortKey (Sort&, ObjCompareFunc* cmpFunc, Int order, const void*& dataSave)

Add this column and its data to the Sort object. It may allocate some storage on the heap, which will be saved in the argument dataSave. The function freeSortKey must be called to free this storage.

virtual void freeSortKey (const void*& dataSave)

Free storage on the heap allocated by makeSortkey(). The pointer will be set to zero.

virtual void allocIterBuf (void& lastVal, void& curVal, ObjCompareFunc*& cmpFunc)

Allocate value buffers for the table iterator. Also get a comparison function if undefined. The function freeIterBuf must be called to free the buffers.

virtual void freeIterBuf (void& lastVal, void& curVal)

Free the value buffers allocated by allocIterBuf.