#include <DS_Table.h>
Classes | |
struct | Cell |
Holds the actual data in the table. More... | |
struct | ColumnDescriptor |
struct | Row |
Stores the list of cells for this row, and a special flag used for internal sorting. More... | |
Public Types | |
enum | SortQueryType |
Increasing or decreasing sort order. | |
Public Member Functions | |
Table () | |
Constructor. | |
~Table () | |
Destructor. | |
unsigned | AddColumn (const char columnName[_TABLE_MAX_COLUMN_NAME_LENGTH], ColumnType columnType) |
Adds a column to the table. | |
void | RemoveColumn (unsigned columnIndex) |
Removes a column by index. | |
unsigned | ColumnIndex (char columnName[_TABLE_MAX_COLUMN_NAME_LENGTH]) |
Gets the index of a column by name Column indices are stored in the order they are added. | |
char * | ColumnName (unsigned index) const |
Gives the string name of the column at a certain index. | |
ColumnType | GetColumnType (unsigned index) const |
Returns the type of a column, referenced by index. | |
unsigned | GetColumnCount (void) const |
unsigned | GetRowCount (void) const |
Table::Row * | AddRow (unsigned rowId) |
Adds a row to the table New rows are added with empty values for all cells. However, if you specify initialCelLValues you can specify initial values It's up to you to ensure that the values in the specific cells match the type of data used by that row rowId can be considered the primary key for the row. It is much faster to lookup a row by its rowId than by searching keys. rowId must be unique Rows are stored in sorted order in the table, using rowId as the sort key. | |
bool | RemoveRow (unsigned rowId) |
void | RemoveRows (Table *tableContainingRowIDs) |
bool | UpdateCell (unsigned rowId, unsigned columnIndex, int value) |
void | GetCellValueByIndex (unsigned rowIndex, unsigned columnIndex, int *output) |
Row * | GetRowByID (unsigned rowId) const |
Row * | GetRowByIndex (unsigned rowIndex, unsigned *key) const |
void | QueryTable (unsigned *columnIndicesSubset, unsigned numColumnSubset, FilterQuery *inclusionFilters, unsigned numInclusionFilters, unsigned *rowIds, unsigned numRowIDs, Table *result) |
Queries the table, optionally returning only a subset of columns and rows. | |
void | SortTable (Table::SortQuery *sortQueries, unsigned numSortQueries, Table::Row **out) |
Sorts the table by rows You can sort the table in ascending or descending order on one or more columns Columns have precedence in the order they appear in the sortQueries array If a row cell on column n has the same value as a a different row on column n, then the row will be compared on column n+1. | |
void | Clear (void) |
Frees all memory in the table. | |
void | PrintColumnHeaders (char *out, int outLength, char columnDelineator) const |
void | PrintRow (char *out, int outLength, char columnDelineator, bool printDelineatorForBinary, Table::Row *inputRow) const |
DataStructures::List < ColumnDescriptor > & | GetColumns (void) |
Direct access to make things easier. | |
const DataStructures::BPlusTree < unsigned, Row *, _TABLE_BPLUS_TREE_ORDER > & | GetRows (void) const |
Direct access to make things easier. | |
DataStructures::Page< unsigned, DataStructures::Table::Row *, _TABLE_BPLUS_TREE_ORDER > * | GetListHead (void) |
Get the head of a linked list containing all the row data. | |
unsigned | GetAvailableRowId (void) const |
unsigned Table::AddColumn | ( | const char | columnName[_TABLE_MAX_COLUMN_NAME_LENGTH], | |
ColumnType | columnType | |||
) |
Adds a column to the table.
[in] | columnName | The name of the column |
[in] | columnType | What type of data this column will hold |
Table::Row * Table::AddRow | ( | unsigned | rowId | ) |
Adds a row to the table New rows are added with empty values for all cells. However, if you specify initialCelLValues you can specify initial values It's up to you to ensure that the values in the specific cells match the type of data used by that row rowId can be considered the primary key for the row. It is much faster to lookup a row by its rowId than by searching keys. rowId must be unique Rows are stored in sorted order in the table, using rowId as the sort key.
[in] | rowId | The UNIQUE primary key for the row. This can never be changed. |
[in] | initialCellValues | Initial values to give the row (optional) |
unsigned Table::ColumnIndex | ( | char | columnName[_TABLE_MAX_COLUMN_NAME_LENGTH] | ) |
Gets the index of a column by name Column indices are stored in the order they are added.
[in] | columnName | The name of the column |
char * Table::ColumnName | ( | unsigned | index | ) | const |
Gives the string name of the column at a certain index.
[in] | index | The index of the column |
unsigned Table::GetAvailableRowId | ( | void | ) | const |
Get the first free row id. This could be made more efficient.
void Table::GetCellValueByIndex | ( | unsigned | rowIndex, | |
unsigned | columnIndex, | |||
int * | output | |||
) |
Note this is much less efficient to call than GetRow, then working with the cells directly Numeric, string, binary
unsigned Table::GetColumnCount | ( | void | ) | const |
Returns the number of columns
Table::ColumnType Table::GetColumnType | ( | unsigned | index | ) | const |
Returns the type of a column, referenced by index.
[in] | index | The index of the column |
Table::Row * Table::GetRowByID | ( | unsigned | rowId | ) | const |
Gets a row. More efficient to do this and access Row::cells than to repeatedly call GetCell. You can also update cells in rows from this function.
[in] | rowId | The ID of the row |
Table::Row * Table::GetRowByIndex | ( | unsigned | rowIndex, | |
unsigned * | key | |||
) | const |
Gets a row at a specific index rowIndex should be less than GetRowCount()
[in] | rowIndex | The index of the row |
[out] | key | The ID of the row returned |
unsigned Table::GetRowCount | ( | void | ) | const |
Returns the number of rows
void Table::PrintColumnHeaders | ( | char * | out, | |
int | outLength, | |||
char | columnDelineator | |||
) | const |
Prints out the names of all the columns
[out] | out | A pointer to an array of bytes which will hold the output. |
[in] | outLength | The size of the out array |
[in] | columnDelineator | What character to print to delineate columns |
void Table::PrintRow | ( | char * | out, | |
int | outLength, | |||
char | columnDelineator, | |||
bool | printDelineatorForBinary, | |||
Table::Row * | inputRow | |||
) | const |
Writes a text representation of the row to out
[out] | out | A pointer to an array of bytes which will hold the output. |
[in] | outLength | The size of the out array |
[in] | columnDelineator | What character to print to delineate columns |
[in] | printDelineatorForBinary | Binary output is not printed. True to still print the delineator. |
[in] | inputRow | The row to print |
void Table::QueryTable | ( | unsigned * | columnIndicesSubset, | |
unsigned | numColumnSubset, | |||
FilterQuery * | inclusionFilters, | |||
unsigned | numInclusionFilters, | |||
unsigned * | rowIds, | |||
unsigned | numRowIDs, | |||
Table * | result | |||
) |
Queries the table, optionally returning only a subset of columns and rows.
[in] | columnSubset | An array of column indices. Only columns in this array are returned. Pass 0 for all columns |
[in] | numColumnSubset | The number of elements in columnSubset |
[in] | inclusionFilters | An array of FilterQuery. All filters must pass for the row to be returned. |
[in] | numInclusionFilters | The number of elements in inclusionFilters |
[in] | rowIds | An arrow of row IDs. Only these rows with these IDs are returned. Pass 0 for all rows. |
[in] | numRowIDs | The number of elements in rowIds |
[out] | result | The result of the query. If no rows are returned, the table will only have columns. |
void Table::RemoveColumn | ( | unsigned | columnIndex | ) |
Removes a column by index.
[in] | columnIndex | The index of the column to remove |
bool Table::RemoveRow | ( | unsigned | rowId | ) |
Removes a row specified by rowId
[in] | rowId | The ID of the row |
void Table::RemoveRows | ( | Table * | tableContainingRowIDs | ) |
Removes all the rows with IDs that the specified table also has
[in] | tableContainingRowIDs | The IDs of the rows |
void Table::SortTable | ( | Table::SortQuery * | sortQueries, | |
unsigned | numSortQueries, | |||
Table::Row ** | out | |||
) |
Sorts the table by rows You can sort the table in ascending or descending order on one or more columns Columns have precedence in the order they appear in the sortQueries array If a row cell on column n has the same value as a a different row on column n, then the row will be compared on column n+1.
[in] | sortQueries | A list of SortQuery structures, defining the sorts to perform on the table |
[in] | numColumnSubset | The number of elements in numSortQueries |
[out] | out | The address of an array of Rows, which will receive the sorted output. The array must be long enough to contain all returned rows, up to GetRowCount() |
bool Table::UpdateCell | ( | unsigned | rowId, | |
unsigned | columnIndex, | |||
int | value | |||
) |
Updates a particular cell in the table
Row pointers do not change, so you can also write directly to the rows for more efficiency.
[in] | rowId | The ID of the row |
[in] | columnIndex | The column of the cell |
[in] | value | The data to set |