Modified backend and frontend for handling grouping of datasets

src/main/java/org/aksw/gerbil/annotator/AnnotatorConfigurationImpl.java

@@ -23,11 +23,12 @@
 import org.aksw.gerbil.datatypes.ErrorTypes;
 import org.aksw.gerbil.datatypes.ExperimentType;
 import org.aksw.gerbil.exceptions.GerbilException;
+import org.aksw.gerbil.web.config.DatasetsConfig;
 
 /**
  * Contains all information needed to load an annotator for a specific
  * experiment type.
- * 
+ *
  * @author Michael Röder ([email protected])
  *
  */
@@ -39,7 +40,7 @@ public class AnnotatorConfigurationImpl extends AbstractAdapterConfiguration imp
     public AnnotatorConfigurationImpl(String annotatorName, boolean couldBeCached,
             Constructor<? extends Annotator> constructor, Object constructorArgs[],
             ExperimentType applicableForExperiment) {
-        super(annotatorName, couldBeCached, applicableForExperiment);
+        super(annotatorName, DatasetsConfig.DEFAULT_DATASET_GROUP, couldBeCached, applicableForExperiment);
         this.constructor = constructor;
         this.constructorArgs = constructorArgs;
     }
@@ -87,4 +88,4 @@ public String toString() {
         builder.append(')');
         return builder.toString();
     }
-}
+}

src/main/java/org/aksw/gerbil/dataset/AbstractDatasetConfiguration.java

@@ -33,10 +33,10 @@ public abstract class AbstractDatasetConfiguration extends AbstractAdapterConfig
     protected EntityCheckerManager entityCheckerManager;
     protected SameAsRetriever globalRetriever;
 
-    public AbstractDatasetConfiguration(String datasetName, boolean couldBeCached,
+    public AbstractDatasetConfiguration(String datasetName,String datasetGroup, boolean couldBeCached,
             ExperimentType applicableForExperiment, EntityCheckerManager entityCheckerManager,
             SameAsRetriever globalRetriever) {
-        super(datasetName, couldBeCached, applicableForExperiment);
+        super(datasetName,datasetGroup, couldBeCached, applicableForExperiment);
         this.entityCheckerManager = entityCheckerManager;
         this.globalRetriever = globalRetriever;
     }

src/main/java/org/aksw/gerbil/dataset/AdapterConfigSerializer.java

@@ -0,0 +1,24 @@
+package org.aksw.gerbil.dataset;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import org.aksw.gerbil.datatypes.AbstractAdapterConfiguration;
+
+import java.io.IOException;
+
+public class AdapterConfigSerializer extends StdSerializer<AbstractAdapterConfiguration> {
+
+
+    public AdapterConfigSerializer(Class<AbstractAdapterConfiguration> t) {
+        super(AbstractAdapterConfiguration.class);
+    }
+
+    @Override
+    public void serialize(AbstractAdapterConfiguration value, JsonGenerator gen, SerializerProvider provider) throws IOException {
+        gen.writeStartObject();
+        gen.writeStringField("name", value.getName());
+        gen.writeStringField("group", value.getGroup());
+        gen.writeEndObject();
+    }
+}

src/main/java/org/aksw/gerbil/dataset/Dataset.java

@@ -31,6 +31,6 @@ public interface Dataset extends Closeable {
     public void setName(String name);
 
     public List<Document> getInstances();
-    
+
     public void setClosePermitionGranter(ClosePermitionGranter granter);
 }

src/main/java/org/aksw/gerbil/dataset/DatasetConfigurationImpl.java

@@ -28,11 +28,11 @@ public class DatasetConfigurationImpl extends AbstractDatasetConfiguration {
     protected Constructor<? extends Dataset> constructor;
     protected Object constructorArgs[];
 
-    public DatasetConfigurationImpl(String datasetName, boolean couldBeCached,
+    public DatasetConfigurationImpl(String datasetName,String datasetGroup, boolean couldBeCached,
             Constructor<? extends Dataset> constructor, Object constructorArgs[],
             ExperimentType applicableForExperiment, EntityCheckerManager entityCheckerManager,
             SameAsRetriever globalRetriever) {
-        super(datasetName, couldBeCached, applicableForExperiment, entityCheckerManager, globalRetriever);
+        super(datasetName, datasetGroup, couldBeCached, applicableForExperiment, entityCheckerManager, globalRetriever);
         this.constructor = constructor;
         this.constructorArgs = constructorArgs;
     }
@@ -66,4 +66,4 @@ public String toString() {
         builder.append(')');
         return builder.toString();
     }
-}
+}

src/main/java/org/aksw/gerbil/dataset/InstanceListBasedDataset.java

@@ -24,6 +24,7 @@
 import org.aksw.gerbil.semantic.sameas.SameAsRetriever;
 import org.aksw.gerbil.transfer.nif.Document;
 import org.aksw.gerbil.utils.ClosePermitionGranter;
+import org.aksw.gerbil.web.config.DatasetsConfig;
 
 public class InstanceListBasedDataset extends AbstractDatasetConfiguration implements Dataset {
 
@@ -34,13 +35,13 @@ public InstanceListBasedDataset(List<Document> instances, ExperimentType applica
     }
 
     public InstanceListBasedDataset(String name, List<Document> instances, ExperimentType applicableForExperiment) {
-        super(name, false, applicableForExperiment, null, null);
+        super(name, DatasetsConfig.DEFAULT_DATASET_GROUP, false, applicableForExperiment, null, null);
         this.instances = instances;
     }
 
     public InstanceListBasedDataset(String name, List<Document> instances, ExperimentType applicableForExperiment,
             EntityCheckerManager entityCheckerManager, SameAsRetriever globalRetriever) {
-        super(name, false, applicableForExperiment, entityCheckerManager, globalRetriever);
+        super(name, DatasetsConfig.DEFAULT_DATASET_GROUP, false, applicableForExperiment, entityCheckerManager, globalRetriever);
         this.instances = instances;
     }
 

src/main/java/org/aksw/gerbil/dataset/SingletonDatasetConfigImpl.java

@@ -34,11 +34,11 @@ public class SingletonDatasetConfigImpl extends DatasetConfigurationImpl impleme
     protected int instanceUsages = 0;
     protected Semaphore instanceMutex = new Semaphore(1);
 
-    public SingletonDatasetConfigImpl(String annotatorName, boolean couldBeCached,
+    public SingletonDatasetConfigImpl(String annotatorName, String annotatorGroup, boolean couldBeCached,
             Constructor<? extends Dataset> constructor, Object constructorArgs[],
             ExperimentType applicableForExperiment, EntityCheckerManager entityCheckerManager,
             SameAsRetriever globalRetriever) {
-        super(annotatorName, couldBeCached, constructor, constructorArgs, applicableForExperiment, entityCheckerManager,
+        super(annotatorName, annotatorGroup, couldBeCached, constructor, constructorArgs, applicableForExperiment, entityCheckerManager,
                 globalRetriever);
     }
 

src/main/java/org/aksw/gerbil/dataset/datahub/DatahubNIFConfig.java

@@ -29,6 +29,7 @@
 import org.aksw.gerbil.dataset.impl.nif.FileBasedNIFDataset;
 import org.aksw.gerbil.datatypes.ExperimentType;
 import org.aksw.gerbil.semantic.sameas.SameAsRetriever;
+import org.aksw.gerbil.web.config.DatasetsConfig;
 import org.apache.jena.riot.Lang;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -44,7 +45,7 @@ public class DatahubNIFConfig extends AbstractDatasetConfiguration {
 
     public DatahubNIFConfig(String datasetName, String datasetUrl, boolean couldBeCached, EntityCheckerManager entityCheckerManager,
             SameAsRetriever globalRetriever) {
-        super(datasetName, couldBeCached, ExperimentType.A2KB, entityCheckerManager, globalRetriever);
+        super(datasetName, DatasetsConfig.DEFAULT_DATASET_GROUP, couldBeCached, ExperimentType.A2KB, entityCheckerManager, globalRetriever);
         this.datasetUrl = datasetUrl;
         rt = new RestTemplate();
     }

src/main/java/org/aksw/gerbil/dataset/impl/AbstractDataset.java

@@ -24,6 +24,9 @@
 public abstract class AbstractDataset implements Dataset {
 
     protected String name;
+
+    protected String group;
+
     protected ClosePermitionGranter granter;
 
     public AbstractDataset() {

src/main/java/org/aksw/gerbil/dataset/impl/nif/NIFFileDatasetConfig.java

@@ -21,6 +21,7 @@
 import org.aksw.gerbil.dataset.check.EntityCheckerManager;
 import org.aksw.gerbil.datatypes.ExperimentType;
 import org.aksw.gerbil.semantic.sameas.SameAsRetriever;
+import org.aksw.gerbil.web.config.DatasetsConfig;
 import org.apache.jena.riot.Lang;
 
 public class NIFFileDatasetConfig extends AbstractDatasetConfiguration {
@@ -29,7 +30,7 @@ public class NIFFileDatasetConfig extends AbstractDatasetConfiguration {
 
     public NIFFileDatasetConfig(String name, String file, boolean couldBeCached, ExperimentType applicableForExperiment,
             EntityCheckerManager entityCheckerManager, SameAsRetriever globalRetriever) {
-        super(name, couldBeCached, applicableForExperiment, entityCheckerManager, globalRetriever);
+        super(name, DatasetsConfig.DEFAULT_DATASET_GROUP, couldBeCached, applicableForExperiment, entityCheckerManager, globalRetriever);
         this.file = file;
     }
 

src/main/java/org/aksw/gerbil/datatypes/AbstractAdapterConfiguration.java

@@ -23,25 +23,35 @@ public abstract class AbstractAdapterConfiguration implements AdapterConfigurati
     private static final ExperimentTypeComparator EXP_TYPE_COMPARATOR = new ExperimentTypeComparator();
 
     protected String name;
+    protected String group;
     protected boolean couldBeCached;
     protected ExperimentType applicableForExperiment;
 
-    public AbstractAdapterConfiguration(String name, boolean couldBeCached, ExperimentType applicableForExperiment) {
+    public AbstractAdapterConfiguration(String name,String group, boolean couldBeCached, ExperimentType applicableForExperiment) {
         this.name = name;
         this.couldBeCached = couldBeCached;
         this.applicableForExperiment = applicableForExperiment;
+        this.setGroup(group);
     }
 
     @Override
     public String getName() {
         return name;
     }
 
+    public String getGroup() {
+        return group;
+    }
+
     @Override
     public void setName(String name) {
         this.name = name;
     }
 
+    @Override
+    public void setGroup(String group) {
+        this.group = group;
+    }
     @Override
     public boolean couldBeCached() {
         return couldBeCached;

src/main/java/org/aksw/gerbil/datatypes/AdapterConfiguration.java

@@ -19,22 +19,22 @@
 /**
  * Interface of an adpater configuration of the GERBIL system. It represents the
  * adapter and is able to create an adapter instance.
- * 
+ *
  * @author Michael Röder
- * 
+ *
  */
 public interface AdapterConfiguration extends Comparable<AdapterConfiguration>{
 
     /**
      * Getter of the adapters name.
-     * 
+     *
      * @return The name of the adapter.
      */
     public String getName();
 
     /**
      * Setter of the adapters name.
-     * 
+     *
      * @param name
      *            The name of the adapter.
      */
@@ -43,7 +43,7 @@ public interface AdapterConfiguration extends Comparable<AdapterConfiguration>{
     /**
      * Returns true if the system is allowed to cache the results of experiments
      * in which this adapter has been involved.
-     * 
+     *
      * @return true if the results could be cached inside the database.
      *         Otherwise false is returned.
      */
@@ -53,21 +53,36 @@ public interface AdapterConfiguration extends Comparable<AdapterConfiguration>{
      * Setter for the caching flag which should be set to true if the system is
      * allowed to cache the results of experiments in which this adapter has
      * been involved.
-     * 
+     *
      * @param couldBeCached
      */
     public void setCouldBeCached(boolean couldBeCached);
 
     /**
      * Returns true if this adapter can be used for an experiment of the given
      * type.
-     * 
+     *
      * @param type
      *            the experiment type that should be checked
      * @return true if this adapter can be used for an experiment of the given
      *         type.
      */
     public boolean isApplicableForExperiment(ExperimentType type);
-    
+
     public ExperimentType getExperimentType();
+
+    /**
+     * Getter of the adapter's group.
+     *
+     * @return The group of the adapter.
+     */
+    public String getGroup();
+
+    /**
+     * Getter of the adapter's group.
+     *
+     * @param group
+     *            The name of the adapter.
+     */
+    public void setGroup(String group);
 }

src/main/java/org/aksw/gerbil/web/MainController.java

@@ -18,17 +18,14 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
+import java.util.*;
 
 import javax.annotation.PostConstruct;
 import javax.servlet.http.HttpServletRequest;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.core.type.TypeReference;
 import org.aksw.gerbil.Experimenter;
 import org.aksw.gerbil.config.GerbilConfiguration;
 import org.aksw.gerbil.database.ExperimentDAO;
@@ -306,18 +303,29 @@ public ModelAndView experiment(@RequestParam(value = "id") String id, HttpServle
     }
 
     @RequestMapping("/datasets")
-    public @ResponseBody List<String> datasets(@RequestParam(value = "experimentType") String experimentType) {
+    public @ResponseBody Map<String, List<String>> datasets(@RequestParam(value = "experimentType") String experimentType) {
         ExperimentType type = null;
+        Map<String, List<String>> response = new TreeMap<>();
+        ObjectMapper mapper = new ObjectMapper();
         try {
             type = ExperimentType.valueOf(experimentType);
         } catch (IllegalArgumentException e) {
             LOGGER.warn("Got a request containing a wrong ExperimentType (\"{}\"). Ignoring it.", experimentType);
             return null;
         }
-        Set<String> datasets = adapterManager.getDatasetNamesForExperiment(type);
-        List<String> list = Lists.newArrayList(datasets);
-        Collections.sort(list);
-        return list;
+        List<String> adapterDetailsJsonList = adapterManager.getDatasetDetailsForExperiment(type);
+        for (String adapterJson : adapterDetailsJsonList) {
+            try {
+                Map<String, String> adapterDetails = mapper.readValue(adapterJson, new TypeReference<Map<String, String>>() {});
+                String name = adapterDetails.get("name");
+                String group = adapterDetails.get("group");
+                response.computeIfAbsent(group, k -> new ArrayList<>()).add(name);
+                Collections.sort(response.get(group));
+            } catch (IOException e) {
+                LOGGER.error("Failed to parse adapter details JSON: {}", adapterJson, e);
+            }
+        }
+        return response;
     }
 
     /**

src/main/java/org/aksw/gerbil/web/config/AdapterList.java

@@ -24,6 +24,11 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import org.aksw.gerbil.dataset.AdapterConfigSerializer;
+import org.aksw.gerbil.datatypes.AbstractAdapterConfiguration;
 import org.aksw.gerbil.datatypes.AdapterConfiguration;
 import org.aksw.gerbil.datatypes.ExperimentType;
 
@@ -85,6 +90,25 @@ public Set<String> getAdapterNamesForExperiment(ExperimentType type) {
         return names;
     }
 
+    public List<String> getAdapterDetailsForExperiment(ExperimentType type) {
+        List<T> configs = getAdaptersForExperiment(type);
+        List<String> serializedConfigs = new ArrayList<>();
+        ObjectMapper mapper = new ObjectMapper();
+        SimpleModule module = new SimpleModule();
+        module.addSerializer(AbstractAdapterConfiguration.class, new AdapterConfigSerializer(AbstractAdapterConfiguration.class));
+        mapper.registerModule(module);
+        for (T config : configs) {
+            String json = null;
+            try {
+                json = mapper.writeValueAsString(config);
+            } catch (JsonProcessingException e) {
+                throw new RuntimeException(e);
+            }
+            serializedConfigs.add(json);
+        }
+        return serializedConfigs;
+    }
+
     public List<T> getAdaptersForName(String name) {
         if (nameToAdapterMapping.containsKey(name)) {
             return nameToAdapterMapping.get(name);