---

CdbBdbNTupleP.ddl

Go to the documentation of this file.

#ifndef CDBBDBTABLE_NTUPLE_P_HH
#define CDBBDBTABLE_NTUPLE_P_HH

// File and Version Information:
//      $Id: CdbBdbNTupleP.ddl,v 1.3 2004/03/26 02:45:41 gapon Exp $

#include "CdbBdbTable/CdbBdbNTupleBaseP.hh"

/// An abstract base class for persistent n-tuples
/**
  * This class adds a type safe interface of the n-tuple model by prividing
  * a set of virtual methods to access or modify the contents of a tuple.
  *
  * RESTRICTIONS:
  *
  *   (1) Rows are numbered beginning from 0.
  *
  *   (2) In all operations with rows, a row is defined through a STD vector
  *       of element type. The number of elements in the vector must be exactly
  *       the number of columns passed to the constructor.
  */
template< class E >
class CdbBdbNTupleP : public CdbBdbNTupleBaseP {

public:

    typedef E ElementType;

private:

  /// Default constructor (IS NOT IMPLEMENTED)

    CdbBdbNTupleP( );

  /// Copy constructor (IS NOT IMPLEMENTED)

    CdbBdbNTupleP( const CdbBdbNTupleP<E>& );

  /// Assignment operator (IS NOT IMPLEMENTED)

    CdbBdbNTupleP<E>& operator=( const CdbBdbNTupleP<E>& );

protected:

  /// Constructor
  /**
    * @see CdbBdbNTupleBaseP::CdbBdbNTupleBaseP()
    */
    CdbBdbNTupleP( d_ULong                         theNumberOfColumns,
                   const std::string&              theName,
                   const std::string&              theDescription,
                   const std::vector<std::string>& theColumnNames ) :
        CdbBdbNTupleBaseP( theNumberOfColumns,
                           theName,
                           theDescription,
                           theColumnNames )
    {}

public:

  /// Get the number of rows in the tuple

    virtual d_ULong rows( ) const = 0;

  /// Get a row at a specified position
  /**
    * This method has to be implemented by a subclass.
    *
    * @return the completion status of the operation
    *
    * Returned status values:
    *
    *    CdbStatus::Success - successfull completion. The vector passed as a parameter
    *                         will be filled exactly the same number of elements as
    *                         the number of columns in the tuple.
    *
    *    CdbStatus::NotFound - a row with specified number is not found. The vector passed
    *                          as a parameter won't be modified.
    *
    *    CdbStatus::* - any other problem occured preventing the successfull completion
    *                   of the operation. The vector passed as a parameter won't be modified.
    *
    * Also see the RESTRICTIONS section at the defintion of the class for more
    * detailed information on values of parameters.
    *
    */
    virtual CdbStatus get_row( std::vector<ElementType>& theRow,
                               const d_ULong             theNumber ) const = 0;

  /// Append a row by the end of an existing list
  /**
    * This method has to be implemented by a subclass.
    *
    * @return the completion status of the operation
    *
    * Returned status values:
    *
    *    CdbStatus::Success - successfull completion. The vector passed as a parameter
    *                         will be filled exactly the same number of elements as
    *                         the number of columns in the tuple.
    *
    *    CdbStatus::IllegalParameters - an incomplete row with wrong number of elements passed
    *                                   to the method. The number of elements must match
    *                                   the number of columns.
    *
    *    CdbStatus::* - any other problem occured preventing the successfull completion
    *                   of the operation. The vector passed as a parameter won't be modified.
    *
    * Also see the RESTRICTIONS section at the defintion of the class for more
    * detailed information on values of parameters.
    */
    virtual CdbStatus append_row( const std::vector<ElementType>& theRow ) = 0;

  /// Repack the internal storage of the tuple
  /**
    * This operation is meant to optimize the use of the internal storage of
    * the tuple by making the storage size equal to the actual number of elements
    * stored in the tuple.
    *
    * @return the completion status of the operation
    */
    virtual CdbStatus repack( ) = 0;
};

#endif /* CDBBDBTABLE_NTUPLE_P_HH */

---