ISMColumn.h

void putData (ISMBucket* bucket, uInt bucketStartRow, uInt bucketNrrow, uInt bucketRownr, const char* data, uInt lenData, Bool afterLastRow, Bool canSplit)

void replaceData (ISMBucket* bucket, uInt bucketStartRow, uInt bucketNrrow, uInt bucketRownr, uInt& offset, const char* data, uInt lenData, Bool canSplit = True)

Bool addData (ISMBucket* bucket, uInt bucketStartRow, uInt bucketNrrow, uInt bucketRownr, uInt inx, const char* data, uInt lenData, Bool afterLastRow = False, Bool canSplit = True)

void handleSplit (ISMBucket& bucket, const Block<Bool>& duplicated)

virtual Bool compareValue (const void* val1, const void* val2) const

static uInt fromString (void* out, const void* in, uInt n, Conversion::ValueFunction* writeLeng)

static uInt toString (void* out, const void* in, uInt n, Conversion::ValueFunction* readLeng)

static uInt writeStringBE (void* out, const void* in, uInt n)

static uInt readStringBE (void* out, const void* in, uInt n)

static uInt writeStringLE (void* out, const void* in, uInt n)

static uInt readStringLE (void* out, const void* in, uInt n)

Description

Review Status

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

Prerequisite

ISMBase

Etymology

ISMColumn represents a Column in the Incremental Storage Manager.

Synopsis

ISMColumn handles the access to a column containing scalars or direct arrays of the various data types. It uses class ISMBucket to get and put the data into the correct bucket. When the value does not fit in the bucket, the bucket is split and the new bucket is added to the storage manager.

The object maintains a variable indicating the last row ever put. This is used to decide if a put of a value is valid until the end of the table or for that one row only. In this way it does not make any difference if rows are added before or after a value is put
A value put before or at the last row ever put will only affect that one row. The rows before and after it keep their original value. If needed that value is copied.

To optimize (especially sequential) access to the column, ISMColumn maintains the last value gotten and the rows for which it is valid. In this way a get does not need to access the data in the bucket.

ISMColumn use the static conversion functions in the Conversion framework to get/put the data in external format (be it canonical or local). Most data types are fixed length, but some are variable length (e.g. String). In external format variable length data is preceeded by its total length (which includes the length itself). This makes it possible to get the length of a data value without having to interpret it, which is easy when (re)moving a value. For this reason ISMColumn contains its own conversion functions for Strings.

ISMColumn also acts as the base class for more specialized ISM column classes (i.e. ISMIndColumn for indirect columns). In this way ISMBase can hold a block of ISMColumn* for any column. Furthermore ISMColumn contains the hooks to allow a derived class to use other ISMColumn functions (e.g. there are "action" functions for a derived class to react on the duplication or removal of a data value (e.g. due to a bucket split).

Motivation

ISMColumn encapsulates all operations on an ISM Column.

Member Description

ISMColumn (ISMBase* parent, int dataType, uInt colnr)

Create a ISMColumn object with the given parent. It initializes the various variables. It keeps the pointer to its parent (but does not own it).

~ISMColumn()

virtual void setShapeColumn (const IPosition& shape)

Set the shape of an array in the column.

virtual uInt ndim (uInt rownr)

Get the dimensionality of the item in the given row. This is the same for all rows.

virtual IPosition shape (uInt rownr)

Get the shape of the array in the given row. This is the same for all rows.

virtual void doCreate (ISMBucket*)

Let the column object initialize itself for a newly created table. This is meant for a derived class.

virtual void getFile (uInt nrrow)

Let the column object initialize itself for an existing table.

virtual Bool flush (uInt nrrow, Bool fsync)

Flush and optionally fsync the data.. This is meant for a derived class.

void resync (uInt nrrow)

Resync the storage manager with the new file contents. It resets the last rownr put.

virtual void reopenRW()

Let the column reopen its data files for read/write access.

virtual void getBoolV (uInt rownr, Bool* dataPtr)
virtual void getuCharV (uInt rownr, uChar* dataPtr)
virtual void getShortV (uInt rownr, Short* dataPtr)
virtual void getuShortV (uInt rownr, uShort* dataPtr)
virtual void getIntV (uInt rownr, Int* dataPtr)
virtual void getuIntV (uInt rownr, uInt* dataPtr)
virtual void getfloatV (uInt rownr, float* dataPtr)
virtual void getdoubleV (uInt rownr, double* dataPtr)
virtual void getComplexV (uInt rownr, Complex* dataPtr)
virtual void getDComplexV (uInt rownr, DComplex* dataPtr)
virtual void getStringV (uInt rownr, String* dataPtr)

Get a scalar value in the given row.

virtual void putBoolV (uInt rownr, const Bool* dataPtr)
virtual void putuCharV (uInt rownr, const uChar* dataPtr)
virtual void putShortV (uInt rownr, const Short* dataPtr)
virtual void putuShortV (uInt rownr, const uShort* dataPtr)
virtual void putIntV (uInt rownr, const Int* dataPtr)
virtual void putuIntV (uInt rownr, const uInt* dataPtr)
virtual void putfloatV (uInt rownr, const float* dataPtr)
virtual void putdoubleV (uInt rownr, const double* dataPtr)
virtual void putComplexV (uInt rownr, const Complex* dataPtr)
virtual void putDComplexV (uInt rownr, const DComplex* dataPtr)
virtual void putStringV (uInt rownr, const String* dataPtr)

Put a scalar value in the given row.

virtual void getScalarColumnBoolV (Vector<Bool>* dataPtr)
virtual void getScalarColumnuCharV (Vector<uChar>* dataPtr)
virtual void getScalarColumnShortV (Vector<Short>* dataPtr)
virtual void getScalarColumnuShortV (Vector<uShort>* dataPtr)
virtual void getScalarColumnIntV (Vector<Int>* dataPtr)
virtual void getScalarColumnuIntV (Vector<uInt>* dataPtr)
virtual void getScalarColumnfloatV (Vector<float>* dataPtr)
virtual void getScalarColumndoubleV (Vector<double>* dataPtr)
virtual void getScalarColumnComplexV (Vector<Complex>* dataPtr)
virtual void getScalarColumnDComplexV (Vector<DComplex>* dataPtr)
virtual void getScalarColumnStringV (Vector<String>* dataPtr)

Get the scalar values in the entire column. The buffer pointed to by dataPtr has to have the correct length. (which is guaranteed by the ScalarColumn getColumn function).

virtual void putScalarColumnBoolV (const Vector<Bool>* dataPtr)
virtual void putScalarColumnuCharV (const Vector<uChar>* dataPtr)
virtual void putScalarColumnShortV (const Vector<Short>* dataPtr)
virtual void putScalarColumnuShortV (const Vector<uShort>* dataPtr)
virtual void putScalarColumnIntV (const Vector<Int>* dataPtr)
virtual void putScalarColumnuIntV (const Vector<uInt>* dataPtr)
virtual void putScalarColumnfloatV (const Vector<float>* dataPtr)
virtual void putScalarColumndoubleV (const Vector<double>* dataPtr)
virtual void putScalarColumnComplexV (const Vector<Complex>* dataPtr)
virtual void putScalarColumnDComplexV (const Vector<DComplex>* dataPtr)
virtual void putScalarColumnStringV (const Vector<String>* dataPtr)

Put the scalar values into the entire column. The buffer pointed to by dataPtr has to have the correct length. (which is guaranteed by the ScalarColumn putColumn function).

virtual void getScalarColumnCellsBoolV (const RefRows& rownrs, Vector<Bool>* dataPtr)
virtual void getScalarColumnCellsuCharV (const RefRows& rownrs, Vector<uChar>* dataPtr)
virtual void getScalarColumnCellsShortV (const RefRows& rownrs, Vector<Short>* dataPtr)
virtual void getScalarColumnCellsuShortV (const RefRows& rownrs, Vector<uShort>* dataPtr)
virtual void getScalarColumnCellsIntV (const RefRows& rownrs, Vector<Int>* dataPtr)
virtual void getScalarColumnCellsuIntV (const RefRows& rownrs, Vector<uInt>* dataPtr)
virtual void getScalarColumnCellsfloatV (const RefRows& rownrs, Vector<float>* dataPtr)
virtual void getScalarColumnCellsdoubleV (const RefRows& rownrs, Vector<double>* dataPtr)
virtual void getScalarColumnCellsComplexV (const RefRows& rownrs, Vector<Complex>* dataPtr)
virtual void getScalarColumnCellsDComplexV (const RefRows& rownrs, Vector<DComplex>* dataPtr)
virtual void getScalarColumnCellsStringV (const RefRows& rownrs, Vector<String>* dataPtr)

Get the scalar values in some cells of the column. The buffer pointed to by dataPtr has to have the correct length. (which is guaranteed by the ScalarColumn getColumnCells function). The default implementation loops through all rows.

virtual void getArrayBoolV (uInt rownr, Array<Bool>* dataPtr)
virtual void getArrayuCharV (uInt rownr, Array<uChar>* dataPtr)
virtual void getArrayShortV (uInt rownr, Array<Short>* dataPtr)
virtual void getArrayuShortV (uInt rownr, Array<uShort>* dataPtr)
virtual void getArrayIntV (uInt rownr, Array<Int>* dataPtr)
virtual void getArrayuIntV (uInt rownr, Array<uInt>* dataPtr)
virtual void getArrayfloatV (uInt rownr, Array<float>* dataPtr)
virtual void getArraydoubleV (uInt rownr, Array<double>* dataPtr)
virtual void getArrayComplexV (uInt rownr, Array<Complex>* dataPtr)
virtual void getArrayDComplexV (uInt rownr, Array<DComplex>* dataPtr)
virtual void getArrayStringV (uInt rownr, Array<String>* dataPtr)

Get an array value in the given row.

virtual void putArrayBoolV (uInt rownr, const Array<Bool>* dataPtr)
virtual void putArrayuCharV (uInt rownr, const Array<uChar>* dataPtr)
virtual void putArrayShortV (uInt rownr, const Array<Short>* dataPtr)
virtual void putArrayuShortV (uInt rownr, const Array<uShort>* dataPtr)
virtual void putArrayIntV (uInt rownr, const Array<Int>* dataPtr)
virtual void putArrayuIntV (uInt rownr, const Array<uInt>* dataPtr)
virtual void putArrayfloatV (uInt rownr, const Array<float>* dataPtr)
virtual void putArraydoubleV (uInt rownr, const Array<double>* dataPtr)
virtual void putArrayComplexV (uInt rownr, const Array<Complex>* dataPtr)
virtual void putArrayDComplexV (uInt rownr, const Array<DComplex>* dataPtr)
virtual void putArrayStringV (uInt rownr, const Array<String>* dataPtr)

Put an array value in the given row.

virtual void addRow (uInt newNrrow, uInt oldNrrow)

Add (newNrrow-oldNrrow) rows to the column and initialize the new rows when needed.

void remove (uInt bucketRownr, ISMBucket* bucket, uInt bucketNrrow, uInt newNrrow)

Remove the given row in the bucket from the column.

static Conversion::ValueFunction* getReaduInt (Bool asCanonical)
static Conversion::ValueFunction* getWriteuInt (Bool asCanonical)

Get the function needed to read/write a uInt from/to external format. This is used by other classes to read the length of a variable data value.

virtual void handleCopy (uInt rownr, const char* value)

Give a derived class the opportunity to react on the duplication of a value. It is used by ISMIndColumn.

virtual void handleRemove (uInt rownr, const char* value)

Give a derived class the opportunity to react on the removal of a value. It is used by ISMIndColumn.

uInt getFixedLength() const

Get the fixed length of the data value in a cell of this column (0 = variable length).

uInt nelements() const

Get the nr of elements in this data value.

int isLastValueInvalid (Int rownr) const

Test if the last value is invalid for this row.

void getValue (uInt rownr, void* value, Bool setCache)

Get the value for this row. Set the cache if the flag is set.

void putValue (uInt rownr, const void* value)

Put the value for this row.

ISMColumn (const ISMColumn&)

Forbid copy constructor.

ISMColumn& operator= (const ISMColumn&)

Forbid assignment.

void init()

Initialize part of the object. It is used by doCreate and getFile.

void clear()

Clear the object (used by destructor and init).

void putFromRow (uInt rownr, const char* data, uInt lenData)

Put the value in all buckets from the given row on.

void putData (ISMBucket* bucket, uInt bucketStartRow, uInt bucketNrrow, uInt bucketRownr, const char* data, uInt lenData, Bool afterLastRow, Bool canSplit)

Put a data value into the bucket. When it is at the first row of the bucket, it replaces the value. Otherwise it is added.

void replaceData (ISMBucket* bucket, uInt bucketStartRow, uInt bucketNrrow, uInt bucketRownr, uInt& offset, const char* data, uInt lenData, Bool canSplit = True)

Replace a value at the given offset in the bucket. If the bucket is too small, it will be split (if allowed).

Bool addData (ISMBucket* bucket, uInt bucketStartRow, uInt bucketNrrow, uInt bucketRownr, uInt inx, const char* data, uInt lenData, Bool afterLastRow = False, Bool canSplit = True)

Add a value at the given index in the bucket. If the bucket is too small, it will be split (if allowed).

void handleSplit (ISMBucket& bucket, const Block<Bool>& duplicated)

Handle the duplicated values after a bucket split.

virtual Bool compareValue (const void* val1, const void* val2) const

Compare the values.

static uInt fromString (void* out, const void* in, uInt n, Conversion::ValueFunction* writeLeng)
static uInt toString (void* out, const void* in, uInt n, Conversion::ValueFunction* readLeng)
static uInt writeStringBE (void* out, const void* in, uInt n)
static uInt readStringBE (void* out, const void* in, uInt n)
static uInt writeStringLE (void* out, const void* in, uInt n)
static uInt readStringLE (void* out, const void* in, uInt n)

Handle a String in copying to/from external format.