CollectionDescription.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef COLLECTIONSVC_COLLECTIONDESCRIPTION_H
#define COLLECTIONSVC_COLLECTIONDESCRIPTION_H
 
#include "StorageSvc/DbType.h"
 
#include <map>
#include <string>
#include <vector>
 
 
namespace pool {
 
  class CollectionColumn;

  class CollectionDescription
  {
  public:
    CollectionDescription( const std::string& name,
                           const DbType& type,
                           const std::string& connection = "" );

    CollectionDescription( const CollectionDescription& rhs );

    virtual ~CollectionDescription();

    CollectionDescription& operator=( const CollectionDescription& rhs );
 
    // Force the use of the user-defined copy operator (the default one leaks)
    CollectionDescription& operator= (CollectionDescription&& rhs)
    { operator=( (const CollectionDescription&) rhs ); return *this; }
 
    // Defaults should work for move.
    CollectionDescription (CollectionDescription&&) = default;

    virtual void setName( const std::string& name );

    virtual void setType( const DbType& type );

    virtual void setConnection( const std::string& connection );

    virtual const CollectionColumn&    insertColumn(
       const std::string& columnName,
       const std::string& columnType );

    virtual const CollectionColumn&    insertTokenColumn(
       const std::string& columnName);
 

    virtual const std::string& name() const;

    virtual const DbType& type() const;

    virtual const std::string& connection() const;

    virtual const std::string& eventReferenceColumnName() const;

    virtual int numberOfTokenColumns() const;

    virtual const CollectionColumn& tokenColumn( int columnId ) const;

    virtual int numberOfAttributeColumns() const;

    virtual const CollectionColumn& attributeColumn( int columnId ) const;
 
    // set column ID, return the ID
    virtual int     setColumnId( const std::string& columnName, int id );
 
 protected:
    // some helper methods for internal use:

    virtual void    copyFrom( const CollectionDescription& rhs );
 
    // clear all internal structures
    virtual void    clearAll();
 
    // set or assign new column ID
    // return the ID
    virtual int     setColumnId( pool::CollectionColumn *column, int id = -1 );
 
    // rise an exception if the column aleready exists
    virtual void    checkNewColumnName( const std::string& name ) const;
 
    // get column by name
    virtual pool::CollectionColumn* column( const std::string& columnName );
 
  private:
    std::string m_name;

    DbType m_type;

    std::string m_connection;

    std::string m_eventReferenceColumnName;
 
    // Token column description objects
    std::vector< pool::CollectionColumn* >  m_tokenColumns;

    std::vector< pool::CollectionColumn* >  m_attributeColumns;

    std::map< std::string, int > m_columnIdForColumnName;
 
    typedef     std::map< std::string, CollectionColumn* >      ColumnByName;
    ColumnByName        m_tokenColumnForColumnName;

    ColumnByName        m_attributeColumnForColumnName;
  };
}
 
#endif