vpf_table.h

Go to the documentation of this file.

/*! \file
  \brief  The VPFTable class.

  \par Copyright Information

  Copyright (c) 2017 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef _VPF_TABLE_H
#define _VPF_TABLE_H

#include "vpf_data_value.h"
#include "vpf_table_header.h"
#include "vpf_util.h"

namespace disti
{
// forward ref
class VPFTableHeader;

/** encapsulates a VPF table */
class VPFTable
{
public:
    /** array of VPFDataValue pointers */
    typedef VPFUtil::PointerArray<VPFDataValue> Row;
    /** array of Row pointers */
    typedef VPFUtil::PointerArray<Row> TableData;

    /**  Load the VPF table with the given filename es
      * \param fname filename of VPF table to load
      * \param abortLoad can be set true by another thread to async abort the load
      */
    VPFTable( const char* const fname, volatile bool& abortLoad );

    /**  Load the VPF table with the given filename and ensure that its columns match the columns
      * described by the given column check structures. Check IsValid() to ensure that table was
      * loaded successfully and columns match check structures
      * \param fname filename of VPF table to load
      * \param columnCheck array of column check structures (!=NULL)
      * \param numColumnCheck number of check structures in columnCheckArray
      * \param abortLoad can be set true by another thread to async abort the load
      */
    VPFTable( const char* const fname, const VPFTableHeader::ColumnDefinition::Check* const columnCheck,
        const unsigned int numColumnCheck, volatile bool& abortLoad );

    /** Dtor
      */
    virtual ~VPFTable();

    /** Get the table header for this table
      * \return table header for table else NULL
      */
    const VPFTableHeader* GetTableHeader( void ) const { return ( _tableHeader ); }

    /** Get the data in the table
      * \return table data else NULL
      */
    const TableData* GetTableData( void ) const { return ( _data ); }

    /** Get number of rows in table ( shortcut for GetTableData()->GetRowCount() )
      * \return number of rows in table
      */
    unsigned int GetRowCount( void ) const { return ( _isValid ? _data->GetCount() : 0u ); };

    /** Get a specific column value from a specific row in the table
      * \param rowNum zero based row number
      * \param colNum zero based column number
      * \return data value from table else NULL
      */
    const VPFDataValue* GetTableValue( const unsigned int rowNum, const unsigned int colNum ) const;

    /** Determine if the table was loaded successfully
      * \return true if loaded else false
      */
    bool IsValid( void ) const { return ( _isValid ); }

protected:
    VPFUtil::WarningBool _isValid;     /**< true if a valid table was loaded else false */
    VPFTableHeader*      _tableHeader; /**< header for table else NULL */
    TableData*           _data;        /**< rows of table data values else NULL */

    /** Initialize instance and load table from file.  Used by Ctor
      * \param fname name of file to load 
      * \param abortLoad can be set true by another thread to async abort the load
      */
    void Initialize( const char* const fname, volatile bool& abortLoad );

    /** Read a row of data described by the given table header from the given file
      * \param infile file to read
      * \param tableHeader table header describing data to read
      * \param abortLoad can be set true by another thread to async abort the load
      * \return new row else NULL
      */
    Row* ReadRow( VPFFile& infile, VPFTableHeader& tableHeader, volatile bool& abortLoad ) const;

    /** Check if a given column definition matches the given column check
      * \param col zero based column number
      * \param check column check
      * \param colCanBeNULL [optional, defaults to false] true if column can optionally be a NULL data type
      *                     and pass this check test
      * \return true if matches else false
      */
    bool CheckColumn( const unsigned int col, const VPFTableHeader::ColumnDefinition::Check& check,
        const bool colCanBeNULL = false ) const;

    /** Check if a given column definition matches a foreign key definition
      * \param col zero based column number
      * \param colName name of column
      * \param colCanBeNULL [optional, defaults to false] true if column can optionally be a NULL data type
      *                     and pass this check test
      * \return true if matches else false
      */
    bool CheckColumnForeignKey( const unsigned int col, const char* const colName, const bool colCanBeNULL = false ) const;

private:
    // Disable implicit generated members
    VPFTable& operator=( const VPFTable& rhs );
    VPFTable( const VPFTable& src );
};

} // end namespace disti

#endif // _VPF_TABLE_H