(r24) WfccmDataContainer < Main < Vanderbilt Biostatistics Wiki

You are here: Vanderbilt Biostatistics Wiki>Main Web>Projects>MicroArrayMassSpec>GeneralWfccmDesign>WfccmDataContainer (revision 24) (raw view)~~EditAttach~~

---+ !! <nop>DataContainer
%TOC%

<noautolink>
---+++ Public Methods
   * %Y% DataContainer(DataContainer) - Copy constructer.
   * %Y% AddColumn(string) - Appends a new column of data, sets the name, and returns the new column's index. Initilizes with null values.
   * %Y% RemoveColumn(int) - Removes a column of data.
   * %Y% RemoveColumns(string, ...) - Removes multiple columns of data by name.
   * %Y% GetColumnName(int) - Gets the column name.
   * %Y% SetColumnName(int, string) - Sets the column name.
   * %Y% GetColIndexFromName(string) - Returns the index for a given column name.
   * %Y% AddRow(int) - Appends a new row of data, sets the id, and returns the new row's index. Initilize with null values.
   * %Y% RemoveRow(int) - Removes a row of data by index.
   * %Y% RemoveRows(int, ...) - Removes multiple rows of data by id.
   * %Y% Filter(int, ...) - Removes all rows except the ones specified.
   * %Y% GetRowId(int) - Gets a row id.
   * %Y% GetRowIndexFromId(int) - Returns the index for a given row id.
   * %Y% Copy() - Returns a new <nop>DataContainer that is a deep copy of this object.
   * %Y% Clear() - Removes all the data, row ids, and col names.
   * %Y% Trim() - Trims the data to the minimum size and runs the garbage collector.
   * %Y% Append(DataContainer) - Takes another <nop>DataContainer and adds the rows to this object. There must be the same number of columns and the column names must be identical. The row ids must be exclusive to each data set, e.g. there can't be the same row id in both data sets. If there is a row id conflict, an error will be thrown and no changes are made to the data.
   * %Y% Merge(DataContainer) - Takes another <nop>DataContainer and adds the columns to this object. Rows that are in one data set and not the other will be added and null values inserted for the rest of the other data set. Column names must be unique to each data set, e.g. there can't be the same column name in both data sets. When there is a column name conflict, an error will be thrown and no changes are made to the data.
   * %Y% Save(string) - Gets the default delimiter and calls the appropriate Save(string, string).
   * %Y% GetDataHeader(string) - Returns an arraylist that contains the header (the column info) for the data set.

---+++ Properties
   * %Y% Name - Gets/sets the name.
   * %Y% NumRows - Gets the number of rows.
   * %Y% NumCols - Gets the number of columns.

---+++ Protected Methods
   * %Y% Copy(DataContainer) - Copies a DataContainer over the current object.
   * %Y% GetDataObject(int, int) - Accesses a data item.
   * %Y% SetDataObject(int, int, object) - Sets a data item.
   * %Y% Delimiter(string) - Determines the default delimiter based on filename.
   * %Y% RebuildColIndices() - Rebuilds the column name to index map.
   * %Y% RebuildRowIndices() - Rebuilds to row id to index map.

---+++ Virtual Methods
   * Load(string) - Place holder for child class implementations.
   * Save(string, string) - Place holder for child class implementations.

---+++ Protected Members
   * ArrayList rowIds - Row index to row id mapping.
   * SortedList rowIndices - Row id to row index mapping.
   * ArrayList colNames - Column index to column name mapping.
   * SortedList colIndices - Column name to column index mapping.
   * ArrayList data - Set of data columns.
   * string name - The name of the data set.

---+++ Exceptions
   * <strike> Merging data with different number of rows. </strike>
   * <strike> Merging data with different row ids. </strike>
   * %Y% Merging data with duplicate column names.
   * %Y% Appending data with different number of columns.
   * %Y% Appending data with different column names.
   * %Y% Appending data with duplicate row ids.
   * %Y% Adding a column with a duplicate name.
   * %Y% Adding a row with a duplicate id.
   * %Y% Setting a column with a duplicate name.
   * %Y% Setting a row with a duplicate id.
   * %Y% Invalid indices.

---+++ Rationale
   * Using columns of data: Columns of data are used due to the fact that there are more rows then columns. This should save some on memory.
   * Whenever a row or column is added, the values are initilised to null values. This takes care of the need for the integrity check. 
   * Whenever a row or column is added, the id or name used cannot interfere with another id/name already in use.

---+++ Remarks
   * Delimiters: tab(default) or comma.

</noautolink>

Topic revision: r24 - 23 Aug 2004, WillGray

Main

Department Home Page

Biostatistics Graduate Program

Vanderbilt University Medical Center

Biostatistics Webs
- Archive
- Main
- Sandbox
- System

Copyright © 2013-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Vanderbilt Biostatistics Wiki? Send feedback