---

CdbSimplestWriteTest.cc

Go to the documentation of this file.

// File and Version Information:
//      $Id: CdbSimplestWriteTest.cc,v 1.14 2005/02/02 15:25:40 gapon Exp $

/// A simplest possible test exploring the API of the Condition/DB
/**
  * This application will write a simple condition object into a database.
  * Note the following simplifications:
  *
  * - default instance (technology/implementation) of Cdb API is used.
  * - default database is assumed
  * - default view is assumed
  */
#include "BaBar/BaBar.hh"

#include "BdbTime/BdbTime.hh"

#include "CdbBase/Cdb.hh"
#include "CdbBase/CdbEnvironment.hh"
#include "CdbBase/CdbCondition.hh"
#include "CdbBase/CdbObject.hh"
#include "CdbBase/CdbTimeUtils.hh"
#include "CdbBase/CdbTransaction.hh"

#include "CdbBdb/CdbBdbTObjectFactory.hh"
#include "CdbBdb/CdbBdbObjectConvertor.hh"

#include "CdbBdbWrapper/CdbBdbWrapper.hh"
#include "CdbBdbShared/CdbBdbShared.hh"

#include "BdbCond/BdbDataListsP.hh"
#include "BdbCond/BdbConditions.hh"

#include "BdbApplication/BdbCondFSNamesStr.hh"
using std::cin;
using std::cout;
using std::endl;

//////////////
// Commands //
//////////////

static void cmd_usage( );

static void cmd_write( const char*    theCondition,
                       const BdbTime& theBeginTime,
                       const BdbTime& theEndTime );

/////////////
// Helpers //
/////////////

static void translate_and_set_defaults( char* argv[],
                                        int&  numArgs,
                                        int&  nextArg );

int
main( int argc, char** argv )
{
    if( argc <= 1 ) {
        cmd_usage( );
        return 0;
    } else if( argc >= 2 ) {
        if(( 0 == strcmp( argv[1], "-h" )) || ( 0 == strcmp( argv[1], "help" ))) {
            cmd_usage( );
            return 0;
        }
    }

  // Make sure the proper libraries are linked and factories
  // are instantiated.

    CdbBdbWrapper::forceLoad( );
    CdbBdbShared::forceLoad( );

  // Translate command-line parameters and set up default environment

    int numArgs = argc - 1;
    int nextArg = 1;

  // Make sure the transaction is in the right mode

    CdbTransaction transaction( CdbTransaction::Update );

  // Check for the environment parameters first. Apply them immediatelly
  // if found.
  //
  // IMPORTANT: Dealing with defaults requires an open transaction since
  //            certain operations may require information loading from
  //            a persistent store.

    translate_and_set_defaults( argv,
                                numArgs,
                                nextArg );

  // Trunslate commands

    const char* condition = 0;

    BdbTime beginTime( BdbTime::now( ));
    BdbTime endTime  ( BdbTime::plusInfinity );

    enum { COMMAND_WRITE } command;

    if( numArgs >= 1 ) {

        if( 0 == strcmp( "write", argv[nextArg] )) {

            command = COMMAND_WRITE;

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;

            if( numArgs >= 1 ) {

                condition = argv[nextArg];

                numArgs = numArgs - 1;
                nextArg = nextArg + 1;

            } else {

                cout << "Illegal syntax of command parameters. Condition name (path)" << endl
                     << "was expected." << endl;

                cmd_usage( );

                return 1;
            }

        } else {
            cout << "Illegal command. A command name was expected." << endl;
            cmd_usage( );
            return 1;
        }
    }
    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-begin" )) {

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;

            if( numArgs < 1 ) {
                cout << "Illegal syntax of command parameters. Begin time value" << endl
                     << "was expected." << endl;
                cmd_usage( );
                return 1;
            }
            if( !CdbTimeUtils::string2time( beginTime, argv[nextArg] )) {
                cout << "Failed to translate the begin time." << endl;
                cmd_usage( );
                return 1;
            }

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;
        }
    }
    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-end" )) {

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;

            if( numArgs < 1 ) {
                cout << "Illegal syntax of command parameters. End time value" << endl
                     << "was expected." << endl;
                cmd_usage( );
                return 1;
            }
            if( !CdbTimeUtils::string2time( endTime, argv[nextArg] )) {
                cout << "Failed to translate the end time." << endl;
                cmd_usage( );
                return 1;
            }

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;
        }
    }
    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-truncate_time" )) {

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;

            if( numArgs < 1 ) {
                cout << "Illegal syntax of command parameters. Truncate time value" << endl
                     << "was expected." << endl;
                cmd_usage( );
                return 1;
            }
            BdbTime truncateTime( 0 );
            if( ! CdbTimeUtils::string2time( truncateTime, argv[nextArg] )) {
                cout << "Failed to translate the truncate time." << endl;
                cmd_usage( );
                return 1;
            }

            numArgs = numArgs - 1;
            nextArg = nextArg + 1;

          // Apply truncate time immediatelly. This operation does not imply
          // any manipulations with a persistent store.

            CdbEnvironment::setTruncateTime( truncateTime );
        }
    }
    if( numArgs > 0 ) {
        cout << "Illegal syntax or number of command parameters." << endl;
        cmd_usage( );
        return 1;
    }

  // Proceed to the required test

    switch( command ) {

    case COMMAND_WRITE:

        cmd_write( condition,
                   beginTime,
                   endTime );
        break;
    }

  // Just to check if it works

    transaction.commitAndHold( );

    return 0;
}

static
void
cmd_usage( )
{
    cout << "Usage:" << endl
         << "    -h" << endl
         << "    help" << endl
         << "    [-t <tech>] [-i <impl>] [-d <db>] [-v <view>] write <condition>        [-begin <time>] [-end <time>] [-truncate_time]" << endl
         << "    [-t <tech>] [-i <impl>] [-d <db>] [-v <view>] write <physical_address> [-begin <time>] [-end <time>] [-truncate_time]" << endl
         << "    [-t <tech>] [-i <impl>] [-d <db>] [-v <view>] write <physical_name>    [-begin <time>] [-end <time>] [-truncate_time]" << endl;
}

static
void
cmd_write( const char*    theCondition,
           const BdbTime& theBeginTime,
           const BdbTime& theEndTime )
{
    assert( 0 != theCondition );

  // Step A : Locate a condition
  //
  // Defaults:
  //
  //   Condition/DB API: technology, implementation
  //   Scope:            database, view
 
    CdbConditionPtr cPtr;
    if( CdbStatus::Success != CdbCondition::instanceFromAny( cPtr,
                                                             theCondition )) {

        cout << "Specified condition was not found in the database." << endl
             << "    CONDITION : \"" << theCondition << "\"" << endl;
        return;
    }

  // Step B : Establish specialized object factory
  //
  // Notes:
  //
  //    This factory object when used by the Condition/DB API will
  //    create a persistent data list with specified (to be passed to the constructor) name
  //    in a proper persistent location.

    CdbBdbTObjectFactory< const char* const, BdbDataListsP > oFactory( "Hello Persistent World!" );

    CdbObjectPtr         oPtr;
    BdbHandle(BdbObject) oH;

  // Step C.1 : Store an object.
  //
  // Notes:
  //
  //   This operation will invoke object creation and its registration in the Conditions
  //   database's meta-data.

    int yes2so;
    cout << "STORE_OBJECT [0=no] : ";
    cin >> yes2so;

    if( yes2so ) {

        if( CdbStatus::Success != cPtr->storeObject( oFactory,
                                                     theBeginTime,
                                                     theEndTime,
                                                     oPtr )) {

            cout << "Failed to store an object for specified period of the validity time" << endl
                 << "using 'storeObject' operation." << endl
                 << "    BEGIN VALIDITY : " << theBeginTime << endl
                 << "    END   VALIDTY  : " << theEndTime << endl;

            return;
        }
        if( CdbStatus::Success != CdbBdbObjectConvertor::narrow( oH,
                                                                 oPtr )) {

            cout << "Failed to narrow a generic object down to the handle." << endl;
            return;
        }
        cout << endl
             << "Stored new object using : 'storeObject'"         << endl
             << "             valid from : " << oPtr->begin   ( ) << endl
             << "                   till : " << oPtr->end     ( ) << endl
             << "             created at : " << oPtr->inserted( ) << endl
             << "        and with handle : " << oH.sprint( )      << endl
             << endl;
    }

  // Step C.2 : Store an object using "storeAndTruncate" method
  //
  // Notes:
  //
  //   This operation will invoke object creation and its registration in the Conditions
  //   database's meta-data.

    int yes2snto;
    cout << "STORE_AND_TRUNCATE_OBJECT [0=no] : ";
    cin >> yes2snto;

    if( yes2snto ) {

        BdbTime storeTime   ( theBeginTime );
        BdbTime truncateTime( theBeginTime + 10 );

        if( CdbStatus::Success != cPtr->storeAndTruncateObject( oFactory,
                                                                storeTime,
                                                                truncateTime,
                                                                oPtr )) {

            cout << "Failed to store an object for specified period of the validity time" << endl
                 << "using 'storeAndTruncateObject' operation." << endl
                 << "    STORE    TIME : " << storeTime << endl
                 << "    TRUNCATE TIME : " << truncateTime << endl;

            return;
        }
        if( CdbStatus::Success != CdbBdbObjectConvertor::narrow( oH,
                                                                 oPtr )) {

            cout << "Failed to narrow a generic object down to the handle." << endl;
            return;
        } 
        cout << endl
             << "Stored new object using : 'storeAndTruncateObject'" << endl
             << "             valid from : " << oPtr->begin  ( )     << endl
             << "                   till : " << oPtr->end    ( )     << endl
             << "             created at : " << oPtr->inserted( )    << endl
             << "        and with handle : " << oH.sprint( )         << endl
             << endl;
    }

  // Do the split operation if required

    int yes2split;
    cout << "SPLIT [0=no] : ";
    cin >> yes2split;

    if( yes2split ) {

        d_ULong seconds;
        cout << "Enter the split point [seconds] : ";
        cin >> seconds;

        BdbTime splitTime( seconds );
        if( CdbStatus::Success != cPtr->split( splitTime )) {

            cout << "Failed to accomplish 'split' operation at specified point" << endl
                 << "of the validity time." << endl
                 << "    SPLIT TIME : " << splitTime << endl;

            return;
        }
        cout << endl
             << "Split done at : " << splitTime << endl
             << endl;
    }
}

static
void
setDefaultEnvironment( const char* theTechnology,
                       const char* theImplementation,
                       const char* theDatabase,
                       const char* theView )
{
    if(( 0 == theTechnology     ) &&
       ( 0 == theImplementation ) &&
       ( 0 == theDatabase       ) &&
       ( 0 == theView           )) return;

  // Get the current environment.

    std::string t = CdbEnvironment::defaultTechnology    ( );
    std::string i = CdbEnvironment::defaultImplementation( t.c_str( ));
    std::string d = CdbEnvironment::defaultDatabase      ( t.c_str( ), i.c_str( ));
    std::string v = CdbEnvironment::defaultView          ( t.c_str( ), i.c_str( ), d.c_str( ));

  // Replace selected components

    if( 0 != theTechnology     ) t = theTechnology;
    if( 0 != theImplementation ) i = theImplementation;
    if( 0 != theDatabase       ) d = theDatabase;
    if( 0 != theView           ) v = theView;

  // And finally put its modified version back

    CdbEnvironment::setDefault( t.c_str( ),
                                i.c_str( ),
                                d.c_str( ),
                                v.c_str( ));
}

static
void
translate_and_set_defaults( char* argv[],
                            int&  numArgs,
                            int&  nextArg )
{
  // Check for the environment parameters first. Apply them immediatelly
  // if found.

    const char* technology     = 0;
    const char* implementation = 0;
    const char* database       = 0;
    const char* view           = 0;

    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-t" )) {
            technology = argv[nextArg+1];
            nextArg = nextArg + 2;
            numArgs = numArgs - 2;
        }
    }
    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-i" )) {
            implementation = argv[nextArg+1];
            nextArg = nextArg + 2;
            numArgs = numArgs - 2;
        }
    }
    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-d" )) {
            database = argv[nextArg+1];
            nextArg = nextArg + 2;
            numArgs = numArgs - 2;
        }
    }
    if( numArgs >= 2 ) {
        if( 0 == strcmp( argv[nextArg], "-v" )) {
            view = argv[nextArg+1];
            nextArg = nextArg + 2;
            numArgs = numArgs - 2;
        }
    }
    setDefaultEnvironment( technology,
                           implementation,
                           database,
                           view );
}

/////////////////
// End Of File //
/////////////////

---