[feature] add constructor/function overloads for DataFrame

Author: jgrewe

Diff for: backend/hdf5/FeatureHDF5.cpp

@@ -11,6 +11,7 @@
 #include <nix/util/util.hpp>
 #include <nix/DataArray.hpp>
 #include "DataArrayHDF5.hpp"
+#include "DataFrameHDF5.hpp"
 
 
 using namespace std;
@@ -71,10 +72,27 @@ FeatureHDF5::FeatureHDF5(const shared_ptr<IFile> &file, const shared_ptr<IBlock>
     : EntityHDF5(file, group, id, time), block(block)
 {
     linkType(link_type);
-    targetType(TargetType::DataArray);
     // TODO: the line below currently throws an exception if the DataArray
     // is not in block - to consider if we prefer copying it to the block
-    this->data(data.id());
+    this->data(data);
+}
+
+
+FeatureHDF5::FeatureHDF5(const shared_ptr<IFile> &file, const shared_ptr<IBlock> &block, const H5Group &group,
+                         const string &id, DataFrame data, LinkType link_type)
+    : FeatureHDF5(file, block, group, id, data, link_type, util::getTime())
+{
+}
+
+
+FeatureHDF5::FeatureHDF5(const shared_ptr<IFile> &file, const shared_ptr<IBlock> &block, const H5Group &group,
+                         const string &id, DataFrame data, LinkType link_type, time_t time)
+    : EntityHDF5(file, group, id, time), block(block)
+{
+    linkType(link_type);
+    // TODO: the line below currently throws an exception if the DataArray
+    // is not in block - to consider if we prefer copying it to the block
+    this->data(data);
 }
 
 
@@ -91,8 +109,8 @@ void FeatureHDF5::targetType(TargetType ttype) {
 }
 
 
-void FeatureHDF5::data(const std::string &name_or_id) {
-    std::shared_ptr<IDataArray> ida = block->getEntity<IDataArray>(name_or_id);
+void FeatureHDF5::data(const DataArray &data) {
+    std::shared_ptr<IDataArray> ida = block->getEntity<IDataArray>(data.name());
     if (!ida) {
         throw std::runtime_error("FeatureHDF5::data: DataArray not found in block!");
     }
@@ -103,6 +121,48 @@ void FeatureHDF5::data(const std::string &name_or_id) {
     auto target = dynamic_pointer_cast<DataArrayHDF5>(ida);
 
     group().createLink(target->group(), "data");
+    targetType(TargetType::DataArray);
+
+    forceUpdatedAt();
+}
+
+
+void FeatureHDF5::data(const DataFrame &data) {
+    std::shared_ptr<IDataFrame> idf = block->getEntity<IDataFrame>(data.name());
+    if (!idf) {
+        throw std::runtime_error("FeatureHDF5::data: DataFrame not found in block!");
+    }
+    if (group().hasGroup("data")) {
+        group().removeGroup("data");
+    }
+
+    auto target = dynamic_pointer_cast<DataFrameHDF5>(idf);
+
+    group().createLink(target->group(), "data");
+    targetType(TargetType::DataFrame);
+    forceUpdatedAt();
+}
+
+
+void FeatureHDF5::data(const std::string &name_or_id) {
+    TargetType tt = TargetType::DataArray;
+    if (group().hasGroup("data")) {
+        group().removeGroup("data");
+    }
+    std::shared_ptr<IDataArray> ida = block->getEntity<IDataArray>(name_or_id);
+    if (!ida) {
+        std::shared_ptr<IDataFrame> idf = block->getEntity<IDataFrame>(name_or_id);
+        if (!idf) {
+            throw std::runtime_error("FeatureHDF5::data: entity is not found in block, neither DataArray nor DataFrame!");
+        }
+        tt = TargetType::DataFrame;
+        auto target = dynamic_pointer_cast<DataFrameHDF5>(idf);
+        group().createLink(target->group(), "data");
+    } else {
+        auto target = dynamic_pointer_cast<DataArrayHDF5>(ida);
+        group().createLink(target->group(), "data");
+    }
+    targetType(tt);
     forceUpdatedAt();
 }
 

Diff for: backend/hdf5/FeatureHDF5.hpp

@@ -60,7 +60,7 @@ class FeatureHDF5 : virtual public base::IFeature, public EntityHDF5 {
 
     std::shared_ptr<base::IBlock> block;
     void targetType(TargetType type);
-    
+
 public:
 
     /**
@@ -69,17 +69,29 @@ class FeatureHDF5 : virtual public base::IFeature, public EntityHDF5 {
     FeatureHDF5(const std::shared_ptr<base::IFile> &file, const std::shared_ptr<base::IBlock> &block, const H5Group &group);
 
     /**
-     * Standard constructor for new Feature
+     * Standard constructor for new Feature linking to a DataArray
      */
     FeatureHDF5(const std::shared_ptr<base::IFile> &file, const std::shared_ptr<base::IBlock> &block, const H5Group &group,
                 const std::string &id, DataArray data, LinkType link_type);
 
     /**
-     * Standard constructor for new Feature with time
+     * Standard constructor for new Feature linking to a DataFrame
+     */
+    FeatureHDF5(const std::shared_ptr<base::IFile> &file, const std::shared_ptr<base::IBlock> &block, const H5Group &group,
+                const std::string &id, DataFrame data, LinkType link_type);
+
+    /**
+     * Standard constructor for new Feature linking a DataArray with time
      */
     FeatureHDF5(const std::shared_ptr<base::IFile> &file, const std::shared_ptr<base::IBlock> &block, const H5Group &group,
                 const std::string &id, DataArray data, LinkType link_type, time_t time);
 
+    /**
+     * Standard constructor for new Feature linking a DataFrame with time
+     */
+    FeatureHDF5(const std::shared_ptr<base::IFile> &file, const std::shared_ptr<base::IBlock> &block, const H5Group &group,
+                const std::string &id, DataFrame data, LinkType link_type, time_t time);
+    
 
     void linkType(LinkType type);
 
@@ -89,8 +101,19 @@ class FeatureHDF5 : virtual public base::IFeature, public EntityHDF5 {
 
     TargetType targetType() const;
 
+    /**
+     * links to the given data (DataArray or DataFrame) method tries to find the given name_or_id
+     * first among the DataArrays and then the DataFrames. When passing a name there might be 
+     * an ambiguity that cannot be resolved. Rather, use the id or use the data(DataArray) or 
+     * data(DataFrame) overloads instead.
+     */
+    DEPRECATED void data(const std::string &name_or_id);
+    
+    
+    void data(const DataArray &data);
+    
 
-    void data(const std::string &name_or_id);
+    void data(const DataFrame &data);
 
 
     std::shared_ptr<base::IDataArray> data() const;