CollectionDescription.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef COLLECTIONBASE_COLLECTIONDESCRIPTION_H
#define COLLECTIONBASE_COLLECTIONDESCRIPTION_H
 
#include "CollectionBase/ICollectionDescription.h"
#include "CollectionBase/ICollectionSchemaEditor.h"
 
#include <map>
 
 
namespace pool {
 
  class CollectionColumn;
  class CollectionIndex;
  
  class CollectionDescription : virtual public ICollectionDescription,
                                virtual public ICollectionSchemaEditor
  {
  public:
    CollectionDescription( const std::string& name,
                           const std::string& type,
                           const std::string& connection = "",
                           const std::string& eventReferenceColumnName = "" );
    
    CollectionDescription( const ICollectionDescription& rhs );
    CollectionDescription( const CollectionDescription& rhs );
 
    virtual ~CollectionDescription();
 
    CollectionDescription& operator=( const ICollectionDescription& rhs );
 
    CollectionDescription& operator=( const CollectionDescription& rhs )
    { operator=( (const ICollectionDescription&) rhs ); return *this; }
 
    bool operator==( const CollectionDescription& rhs ) const;
 
    bool operator!=( const CollectionDescription& rhs ) const;
 
    virtual bool equals( const ICollectionDescription& rhs ) const;
 
    virtual bool isSubsetOf( const ICollectionDescription& rhs ) const;
 
    virtual void setName( const std::string& name );
 
    virtual void setType( const std::string& type );
 
    virtual void setConnection( const std::string& connection );
 
    virtual void setEventReferenceColumnName( const std::string& columnName );
 
    virtual const ICollectionColumn&    insertColumn(
       const std::string& columnName, 
       const std::string& columnType,
       const std::string& annotation = "",
       int maxSize = 0,
       bool sizeIsFixed = true );
 
    virtual  const ICollectionColumn&   insertColumn(
       const std::string& columnName, 
       const std::type_info& columnType,
       const std::string& annotation = "",
       int maxSize = 0,
       bool sizeIsFixed = true );
 
    virtual const ICollectionColumn&    insertTokenColumn(
       const std::string& columnName,
       const std::string& annotation = "");
    
 
    virtual  const ICollectionColumn&    annotateColumn(
       const std::string& columnName,
       const std::string& annotation ); 
 
 
    virtual void dropColumn( const std::string& columnName );
 
    virtual void renameColumn( const std::string& oldName, const std::string& newName );
 
    virtual void changeColumnType( const std::string& columnName,
                                   const std::string& newType,
                                   int maxSize = 0,
                                   bool sizeIsFixed = true );
 
    virtual void changeColumnType( const std::string& columnName,
                                   const std::type_info& newType,
                                   int maxSize = 0,
                                   bool sizeIsFixed = true );
 
    virtual void createIndex( std::string indexName, const std::string& columnName, bool isUnique = false );
 
    virtual void createIndex( std::string indexName, const std::vector< std::string >& columnNames, bool isUnique = false );
 
    virtual void dropIndex( const std::string& columnName );
 
    virtual void dropIndex( const std::vector<std::string>& columnNames );
 
 
    virtual const std::string& name() const;
 
    virtual const std::string& type() const;
 
    virtual const std::string& connection() const;
 
    virtual const std::string& eventReferenceColumnName() const;
 
    virtual bool hasEventReferenceColumn() const;
 
    virtual int numberOfColumns() const;
 
    virtual const ICollectionColumn& column( const std::string& columnName ) const;
 
    virtual const ICollectionColumn* columnPtr( const std::string& columnName ) const;
    
    virtual int numberOfTokenColumns() const;
 
    virtual const ICollectionColumn& tokenColumn( const std::string& columnName ) const; 
 
    virtual const ICollectionColumn& tokenColumn( int columnId ) const; 
 
    virtual int numberOfAttributeColumns() const;
 
    virtual const ICollectionColumn& attributeColumn( const std::string& columnName ) const; 
 
    virtual const ICollectionColumn& attributeColumn( int columnId ) const;
 
    const std::vector< pool::CollectionColumn* >& tokenColumns() const { return m_tokenColumns; }
 
    const std::vector< pool::CollectionColumn* >& attributeColumns() const { return m_attributeColumns; }
 
    virtual int numberOfIndices() const;
 
    virtual const ICollectionIndex& index( const std::string& columnName ) const;
 
    virtual const ICollectionIndex& index( const std::vector<std::string>& columnNames ) const;
 
    virtual const ICollectionIndex& index( int indexId ) const;
 
    // set column ID, return the ID
    virtual int     setColumnId( const std::string& columnName, int id, const std::string& methodName );
    
 protected:
    // some helper methods for internal use:
 
    virtual void    copyFrom( const ICollectionDescription& 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 std::string& method ) const;
 
    // check if the column contains tokens
    virtual bool    isTokenColumn( const std::string& columnName, const std::string& method ) const;
 
    // this version includes the 'method name' in the error message
    virtual pool::CollectionColumn* column( const std::string& columnName, const std::string& methodName );
    virtual const pool::CollectionColumn* column( const std::string& columnName, const std::string& methodName ) const;
 
 public:
    virtual void                printOut() const;
 
    
  private:
    std::string m_name;
 
    std::string 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;
 
    std::vector< CollectionIndex* > m_indices;
  };
}
 
#endif