Merge pull request #147 from mpsonntag/filter

Filter

Author: jgrewe

+nix/Filter.m

@@ -0,0 +1,14 @@
+classdef Filter < uint8
+    %FILTER available nix custom filters
+
+    enumeration
+        accept_all (0); % requires an empty value
+        id (1);
+        ids (2); % requires a cell array
+        type (3);
+        name (4);
+        metadata (5);
+        source (6);
+    end
+    
+end

+nix/Utils.m

@@ -81,6 +81,38 @@
                 retObj = objConstructor(handle);
             end;
         end;
-        
+
+        % -----------------------------------------------------------
+        % nix.Filter helper functions
+        % -----------------------------------------------------------
+
+        function err = valid_filter(filter, val)
+            err = '';
+            if (~isa(filter, 'nix.Filter'))
+                err = 'Valid nix.Filter required';
+                return
+            end
+
+            % Currently matlab will crash, if anything other than
+            % a cell array is handed over to a nix.Filter.ids.
+            if (filter == nix.Filter.ids && ~iscell(val))
+                err = 'nix.Filter.ids requires a cell array';
+                return
+            end
+        end
+
+        function currData = filter(obj, filter, val, mxMethod, objConstructor)
+            valid = nix.Utils.valid_filter(filter, val);
+            if(~isempty(valid))
+                error(valid);
+            end
+
+            currList = nix_mx(mxMethod, obj.nix_handle, uint8(filter), val);
+            currData = cell(length(currList), 1);
+            for i = 1:length(currList)
+                currData{i} = objConstructor(currList{i});
+            end;
+        end
+
     end;
 end

src/filters.h

@@ -0,0 +1,77 @@
+// Copyright (c) 2017, German Neuroinformatics Node (G-Node)
+//
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted under the terms of the BSD License. See
+// LICENSE file in the root of the Project.
+
+#ifndef NIX_MX_FILTERS
+#define NIX_MX_FILTERS
+
+#include <nix.hpp>
+#include "mex.h"
+#include "datatypes.h"
+
+// filter template
+template<typename T, typename FN>
+std::vector<T> filterFileEntity(const extractor &input, FN ff) {
+    std::vector<T> res;
+
+    switch (input.num<uint8_t>(2)) {
+    case switchFilter::AcceptAll:
+        res = ff(nix::util::AcceptAll<T>());
+        break;
+    case switchFilter::Id:
+        res = ff(nix::util::IdFilter<T>(input.str(3)));
+        break;
+    case switchFilter::Ids:
+        // this will crash matlab, if its not a vector of strings...
+        res = ff(nix::util::IdsFilter<T>(input.vec<std::string>(3)));
+        break;
+    case switchFilter::Type:
+        res = ff(nix::util::TypeFilter<T>(input.str(3)));
+        break;
+    case switchFilter::Name:
+        res = ff(nix::util::NameFilter<T>(input.str(3)));
+        break;
+    default: throw std::invalid_argument("unknown or unsupported filter");
+    }
+
+    return res;
+}
+
+template<typename T, typename FN>
+std::vector<T> filterEntity(const extractor &input, FN ff) {
+    std::vector<T> res;
+
+    switch (input.num<uint8_t>(2)) {
+    case switchFilter::AcceptAll:
+        res = ff(nix::util::AcceptAll<T>());
+        break;
+    case switchFilter::Id:
+        res = ff(nix::util::IdFilter<T>(input.str(3)));
+        break;
+    case switchFilter::Ids:
+        // this will crash matlab, if its not a vector of strings...
+        res = ff(nix::util::IdsFilter<T>(input.vec<std::string>(3)));
+        break;
+    case switchFilter::Type:
+        res = ff(nix::util::TypeFilter<T>(input.str(3)));
+        break;
+    case switchFilter::Name:
+        res = ff(nix::util::NameFilter<T>(input.str(3)));
+        break;
+    case switchFilter::Metadata:
+        res = ff(nix::util::MetadataFilter<T>(input.str(3)));
+        break;
+    case switchFilter::Source:
+        res = ff(nix::util::SourceFilter<T>(input.str(3)));
+        break;
+    default: throw std::invalid_argument("unknown or unsupported filter");
+    }
+
+    return res;
+}
+
+#endif

src/utils/datatypes.h

@@ -12,6 +12,16 @@
 #include <nix/DataType.hpp>
 #include <mex.h>
 
+enum switchFilter : int8_t {
+    AcceptAll,
+    Id,
+    Ids,
+    Type,
+    Name,
+    Metadata,
+    Source
+};
+
 inline nix::DataType dtype_mex2nix(const mxArray *array) {
     mxClassID cid = mxGetClassID(array);