CollectionFactory.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef COLLECTIONBASE_COLLECTIONFACTORY_H
#define COLLECTIONBASE_COLLECTIONFACTORY_H
 
#include "CollectionBase/ICollection.h"
#include "CollectionBase/CollectionDescription.h"
#include "FileCatalog/IFileCatalog.h"
#include "CxxUtils/checker_macros.h"
 
#include <string>
#include <vector>
 
 
namespace pool {
   
   class ICollectionDescription;
   class ISession;
   class ICollectionCursor;
 
  class ATLAS_NOT_THREAD_SAFE CollectionFactory
  // not thread-safe due to constness violations wrt the catalog.
  {
  public:
    static CollectionFactory* get();
 
    virtual ICollection* create( const ICollectionDescription& description,
                                 ICollection::OpenMode openMode,
                                 ISession* session = 0 ) const;
 
    virtual ICollection* createAndRegister( const ICollectionDescription& description,
                                            IFileCatalog* collectionCatalog,
                                            bool overwrite = false,
                                            std::string logicalName = "",
                                            ISession* session = 0 ) const;
    
    virtual bool registerExisting( const ICollectionDescription& description,
                                   IFileCatalog* collectionCatalog,
                                   std::string logicalName = "",
                                   ISession* session = 0 ) const;
 
    virtual bool registerExisting( ICollection* collection,
                   bool overwrite,
                                   IFileCatalog* collectionCatalog,
                                   std::string logicalName = "",
                                   ISession* session = 0 ) const;
    
    virtual ICollection* openWithPhysicalName( const std::string& physicalName,
                                               IFileCatalog* collectionCatalog,
                                               ICollection::OpenMode openMode = pool::ICollection::READ,
                                               ISession* session = 0 ) const;
    
    virtual ICollection* openWithLogicalName( const std::string& logicalName,
                                              IFileCatalog* collectionCatalog,
                                              bool readOnly = true,
                                              ISession* session = 0 ) const;
    
    virtual ICollection* openWithGuid( const FileCatalog::FileID& guid,
                                       IFileCatalog* collectionCatalog,
                                       bool readOnly = true,
                                       ISession* session = 0 ) const;
 
 
 
    // resolve PHYSICAL_NAME, LOGICAL_NAME and GUID notation (using catalog)
    virtual void resolveDescription( CollectionDescription& description, bool readOnly = true ) const;
    
    virtual CollectionDescription descFromPhysicalName( const std::string& physicalName,
                                                        IFileCatalog* collectionCatalog,
                                                        bool readOnly ) const;
      
    virtual CollectionDescription descFromLogicalName( const std::string& logicalName,
                                                       IFileCatalog* collectionCatalog,
                                                       bool readOnly ) const;
 
    virtual CollectionDescription descFromGuid( const FileCatalog::FileID& guid,
                                                IFileCatalog* collectionCatalog,
                                                bool readOnly ) const;
 
    void        setDefaultCatalog( pool::IFileCatalog* catalog);
 
    void        setWriteCatalog( const std::string &cat );
    
    IFileCatalog*   getDefaultCatalog() const;
  
  private:
    CollectionFactory();
 
    virtual ~CollectionFactory();
 
    static CollectionFactory s_instance;
 
    static const std::string c_fileType;
 
    bool isUnique( const FileCatalog::FileID& guid,
                   IFileCatalog& collectionCatalog ) const;
 
    void extract( const std::string& physicalName,
                  std::string& type, 
                  std::string& connection,
                  std::string& name ) const;    
 
    
 
    ICollection*    create_callPlugin( const ICollectionDescription& description,
                       ICollection::OpenMode openMode,
                       ISession* session = 0 ) const;
   
    protected:   
    mutable bool        m_myOwnCatalog;
    mutable IFileCatalog*   m_catalog;  
 
  };
 
}
 
#endif