libgofigure-dev 0.9.0-3 / usr / include / gofigure2 / GoDBTableWidgetContainer.h

/*=========================================================================
 Authors: The GoFigure Dev. Team.
 at Megason Lab, Systems biology, Harvard Medical school, 2009-11

 Copyright (c) 2009-11, President and Fellows of Harvard College.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 Neither the name of the  President and Fellows of Harvard College
 nor the names of its contributors may be used to endorse or promote
 products derived from this software without specific prior written
 permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef __GoDBTableWidgetContainer_h
#define __GoDBTableWidgetContainer_h

#include "GoDBTraceInfoForTableWidget.h"
#include "GoDBTraceRow.h"
#include "vtkMySQLDatabase.h"
#include "SelectQueryDatabaseHelper.h"
#include <string>
#include <vector>
#include <list>

#include "QGoIOConfigure.h"
/**
\brief this class describes the columns of the table widget with the corresponding info
to find their values in the database if the columns refer to data stored in the database and
provides methods to fill the rows of the table widget and to get the right queries to
find the data in the database
\ingroup DB
*/
class QGOIO_EXPORT GoDBTableWidgetContainer
{
public:

  /** \brief Default Constructor */
  GoDBTableWidgetContainer();

  /**
  \brief constructor
  \param[in] iCollectionName name of the collection
  \param[in] iTracesName name of the traces
  \param[in] iImgSessionID ID of the imagingsession
  */
  explicit GoDBTableWidgetContainer(std::string iCollectionName, std::string iTracesName,
                                    int iImgSessionID);
  /**
  \brief desctructor
  */
  virtual ~GoDBTableWidgetContainer(){}

  typedef  std::vector< std::pair< GoDBTraceInfoForTableWidget, std::vector< std::string > > >
  TWContainerType;

  /**
  \brief Return a list with all the ColumnNames and tooltips to be displayed in the
  tableWidget
  \return a list with all the ColumnNames and tooltips to be displayed in the
  tableWidget
  */
  std::list< std::pair<std::string, std::string> > GetListColumnsNamesAndToolTipsForTableWidget();

  /**
  \brief Return a list with all the ColumnNames for computed values displayed in the
  tableWidget
  \return a list with all the ColumnNames for computed values displayed in the
  tableWidget
  */
  std::vector< std::string > GetNameComputedColumns();

  /**
  \brief get the results of the queries and put them in the row container corresponding
  to all the data needed to fill the table widget for the traces and return the corresponding
  row container
  \param[in] iDatabaseConnector connection to the database
  \return all the values needed from the database and the description of the info to know
  how to display them in the table widget
  */
  virtual TWContainerType GetContainerLoadedWithAllFromDB(
    vtkMySQLDatabase *iDatabaseConnector,std::list<unsigned int> iListTPs = std::list<unsigned int>());

  /**
  \brief get the results of the queries and put them in the row container corresponding
  to all the data needed to fill the table widget for the updated trace and return the
  link to the corresponding row container which has only 1 row
  \param[in] iDatabaseConnector connection to the database
  \param[in] iTraceID traceID the data are needed for
  \return the row container with all the data for the specific trace
  */
  virtual TWContainerType GetContainerForOneSpecificTrace(vtkMySQLDatabase *iDatabaseConnector,
                                                          int iTraceID);

  /** \brief get the results of the queries and put them in the row container corresponding
  to all the data needed to fill the table widget for the new created trace and return the
  link to the corresponding row container which has only 1 row*/
  //virtual TWContainerType GetContainerForLastCreatedTrace(
  //vtkMySQLDatabase* iDatabaseConnector);

  //void ClearRowContainer();

  std::vector< int > GetIndexForGroupColor(std::string iGroupName);

  /**
  \brief return all the traces IDs present in the RowContainer
  */
  std::vector< int > GetAllTraceIDsInContainer();

  /** *\brief return a list of all the traces with a bounding box
  containing the given ZCoord*/
  //std::list<std::string> GetTracesIDForAGivenZCoord(int iZCoord);

  //std::vector<std::vector<std::string> > GetChannelsInfo();
  /** \brief Set the info needed for mesh*/
  //void SetSpecificColumnsInfoForMesh(
  //std::vector<std::vector<std::string> > iChannelsInfo);

  /** \brief Insert a new created trace with the datas contained in the
  NewTraceContainer into the m_RowContainer*/
  //void InsertNewCreatedTrace(GoDBTableWidgetContainer
  // iLinkToNewTraceContainer);

  //void DeleteSelectedTraces(std::list<int> iSelectedTraces);

  //void UpdateIDs(std::list<int> iListTracesToUpdate,unsigned int
  // NewCollectionID);
protected:
  std::string                                m_CollectionName;
  std::string                                m_CollectionIDName;
  std::string                                m_TracesName;
  std::string                                m_TracesIDName;
  int                                        m_ImgSessionID;
  std::vector< GoDBTraceInfoForTableWidget > m_ColumnsInfos;
  TWContainerType                            m_RowContainer;

  /**
  \brief Fill a vector of GoDBTraceInfoForTableWidget with the info
  needed to fill the table widget for all the traces
  \return a vector with all the info to fill the table widget for
  all the traces
  */
  virtual std::vector< GoDBTraceInfoForTableWidget > GetColumnsInfoForTraceTable();

  /**
  \brief Virtual Pure method Fill the vector of GoDBTraceInfoForTableWidget with the info
  common to 2 traces only
  */
  virtual void SetCommonInfoForTwoTracesTable() = 0;

  void SetInfoForColumnIsVisible();

  virtual void FillRowContainerWithDBValues(
    vtkMySQLDatabase *iDatabaseConnector, std::string iRestrictionName,
    std::string iRestrictionValue, std::list<unsigned int> iListTimepoints = std::list<unsigned int>());

  /** \todo Lydie: find a way to make it ok for all traces, now only for mesh*/
  /** \brief fill the row container with the values calculated and stored in th
  meshAttributes*/
  void FillRowContainerForComputedValues(
    std::vector< std::vector< std::string > > *iComputedValues);

  //int GetLastCreatedTraceID(vtkMySQLDatabase* iDatabaseConnector);

  /** \brief return a vector of the table.fields to be selected from the database
  for all the fields except the ones with the same name if SameFieldsQuery is set
  to false and only for them if SameFieldsQuery is set to true*/
  std::vector< std::string > GetQueryStringForSelectFieldsTables(bool SameFieldsInQuery);

  /** \brief return a vector of string with the tables to be joined with the
 trace table in the database query for all the fields except the ones with the
 same name if SameFieldsQuery is set to false and only for them if
 SameFieldsQuery is set to true*/
  std::vector< std::string > GetQueryStringForTraceJoinedTables(bool SameFieldsInQuery);

  /** \brief fill the columns of the row container following the vector of string
  containing the columns to be filled with the results contained in the vector
  results from query and look on the columnNameDatabase in the column Info by
  default or else*/
  void FillRowContainer(std::vector< std::vector< std::string > > iResultsFromQuery,
                        std::vector< std::string > iSelectFields, std::string BaseOn = "");

  size_t GetNumberOfRows();

  /** *\brief return the index in the row container for the column with the given
  InfoName*/
  int GetIndexInsideRowContainer(std::string iInfoName);

  virtual void ClearRowContainerValues();

  /** \brief Fill the vector of GoDBTraceInfoForTableWidget with the info
  specific to a trace*/
  //virtual void GetSpecificInfoForTraceTable() = 0;
};
#endif