---

CdbBdbSPartitionP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_PARTITION_P_HH
#define CDBBDBSHARED_PARTITION_P_HH

// File and Version Information:
//      $Id: CdbBdbSPartitionP.ddl,v 1.8 2004/08/06 05:54:25 bartoldu Exp $

#include "CdbBdbShared/CdbBdbSPartitionBaseP.hh"
#include "CdbBdbShared/CdbBdbSPartitionListenerP.hh"
#include "CdbBdbShared/CdbBdbSIncrementCollection.hh"

/// Persistent partition class
/**
  * This is an actual implementation of the partition class to be stored
  * in the corresponding persistent "PartitionLayout" collection.
  */
class CdbBdbSPartitionP : public CdbBdbSPartitionBaseP {

private:

  /// Default constructor (NOT IMPLEMENTED))
  /**
    * Also see comments about the special constructor defined above.
    */
    CdbBdbSPartitionP( );

public:

  /// Normal constructor
  /**
    * The partition listener reference is an optional parameter, which is only
    * passed when there is a listener.
    */
    CdbBdbSPartitionP( d_UShort                                 theId,              /**< the identifier of the partition */
                       const char*                              theDescription,     /**< the description of the partition */
                       const BdbTime&                           theCreationTime,    /**< the time when the partition is supposed to be created */
                       const CdbBdbSCell&                       theCell,            /**< the cell (area) occupied by the partition in 2-dimension space */
                       d_UShort                                 theOriginId,        /**< the owner of this partition */
                       const BdbRef(CdbBdbSPartitionListenerP)& theListenerRef      /**< this optional listener will be informed about any changes at partition's state */
                     );

  /// Destructor
  /**
    */
    virtual ~CdbBdbSPartitionP( );

  /// Get the owner of the partition
  /**
    */
    d_UShort originId( ) const;

  /// Get the current status of the partition
  /**
    * One the partition gets created the corresponding database files and containers
    * meant to store the actual condition objects and metadata are not created.
    * In other words, the partition gets into "non-instantiated" state immediatelly
    * upon its creation. At this point the partition is not usable for storinig new
    * condition objects into it or fetching them from it.
    * To get into "instantiated" state a separate method should be called.
    *
    * The main reason to separate partition creation from its instantiation
    * is that partition always get created at the MASTER database, but some
    * of these partitions may be defined to belong to some SLAVE database.
    * Therefore, the data structures supporting member conditions have to be
    * created at the SLAVE rather than at the MASTER.
    *
    * @see CdbBdbSPartitionP::instantiate()
    */
    bool isInstantiated( ) const;

  /// Get the partition modification time
  /**
    * Partition modification (INSERTION) time is meant to indicate when was the last time
    * when any member condition of this partition was most recently updated.
    */
    BdbTime modified( ) const;

  /// Update the partition modification time
  /**
    * The current modification  specified time must be the same or bigger (newer) than the one
    * stored by the partition.
    */
    CdbStatus update( const BdbTime& theModificationTime );

  /// Close the partition at specified point of the INSERTION timeline
  /**
    * The specified time must be strictly greater than the "bottom" insertion time
    * of the partition.
    * It's also required that partition be instantiated before closing it.
    *
    * @see CdbBdbSPartitionP::isInstantiated()
    */
    CdbStatus close( const BdbTime& theTime );

  /// Instantiate supporting data structures
  /**
    * This method will only be able to do its job at the target database (the one
    * (where the partition belongs to).
    *
    * An optional "reinstantiateFlag" is only meant to be used in special cases
    * to reset existing conditions for an existing and "open" partition as if
    * this partition were being created from a scratch. The flag has no effect
    * for non-existing partitions.
    *
    * @see CdbBdbSPartitionP::isInstantiated()
    */
    CdbStatus instantiate( bool reinstantiateFlag = false );

  /// Get the total number of "increments"
  /**
    */
    d_UShort numIncrements( ) const;

  /// Get the specified "increment"
  /**
    * The method will return CdbStatus::NotFound if the index is not
    * in a valid range.
    */
    CdbStatus increment( d_UShort          theNumber,           /**< the number of the increment in question */
                         CdbBdbSIncrement& theIncrement         /**< the value of the increment to be set up */
                       ) const;

  /// Create new "increment"
  /**
    * The method if successfull will increase the number of increments by one.
    */
    CdbStatus createIncrement( const BdbTime& theSplitTime      /**< the split time for a new incrementhe increment */
                             );

  /// Dump the contents of the object
  /**
    */
    virtual void dump( std::ostream& o ) const;

private:

  /// Check if the local origin matches this partition's origin
  /**
    * Certain operations iwth partitions are only available at the database
    * of these partitions' origins.
    *
    * The method will return CdbStatus::Success if there is the origin match.
    */
    CdbStatus matchOrigin( ) const;

private:

    BdbRef(CdbBdbSPartitionListenerP) _listenerRef;

  // This is an embedded class

    CdbBdbSIncrementCollection _increments;

  // Partition modification time is meant to indicate when was the last time
  // when any member condition of this partition was most recently updated.

    BdbTime _modified;

  // Other data members

    d_Boolean _isInstantiated;  // the current status of the partition
    d_UShort  _originId;        // the owner of the partition
};

#endif /* CDBBDBSHARED_PARTITION_P_HH */

---