Package org.fairdatapipeline.api

Class Issue

java.lang.Object
org.fairdatapipeline.api.Issue
public class Issue extends Object
An issue that can be raised with objects or their components.

Issues can be created using Coderun.raise_issue(String, Integer) or with Object_component.raise_issue(String, Integer).

Usage example 

       Object_component_write oc1 = dp.getComponent(component1);
       oc1.raise_issue("something is terribly wrong with this component", 10);
or 
      Issue i = coderun.raise_issue("moderately bad data", 7);
      i.add_components(oc1, oc2, oc3);
or 
      Issue i = coderun.raise_issue("moderately bad data", 7);
      i.add_components(oc1, oc2, oc3);
      i.add_fileObjects(coderun.getCode_repo(), coderun.getScript(), coderun.getConfig());

  • Method Details

    • add_components

      public void add_components(Object_component... components)
      When we have created an issue using coderun.raise_issue() we still need to attach this issue to one or more object components. Note: attach the issue to the 'whole_object' component to indicate that it is linked to the object rather than a specific component.
      Parameters:
      components - - any number of components can be listed as arguments

    • add_fileObjects

      public void add_fileObjects(FileObject... objects)
      When we have created an issue using coderun.raise_issue() we can also attach FileObjects to this issue. This can be used to raise issues with Code_repo, Submission Script, and/or Config File.
      Parameters:
      objects - any number of FileObjects, e.g. coderun.getScript(), coderun.getConfig(), coderun.getCode_repo()