Package org.fairdatapipeline.api

Class Object_component_read

java.lang.Object
org.fairdatapipeline.api.Object_component
org.fairdatapipeline.api.Object_component_read
public class Object_component_read extends Object_component
This represents an object_component to read from (or raise issues with) An object_component without a name is the 'whole_object' component. Ideally the user should only read from named components on toml and h5 files, and only read from the 'whole_object' on any other files. This is not enforced at the moment.

  • Method Details

    • populate_component

      protected void populate_component()

    • readLink

      public Path readLink()
      get the filePath to read from; only for whole_object component
      Returns:
      Path the Path of the data object.

    • readFileChannel

      public CleanableFileChannel readFileChannel() throws IOException
      get the CleanableFileChannel to read directly from the file. only for whole_object component.
      Returns:
      CleanableFileChannel the filechannel to read from.
      Throws:
      IOException - if the file can't be opened.

    • readEstimate

      public Number readEstimate()
      read the Estimate that was stored as this component in a TOML file.
      Returns:
      the estimate as Number

    • readDistribution

      public Distribution readDistribution()
      read the Distribution that was stored as this component in a TOML file.
      Returns:
      the Distribution

    • readSamples

      public List<Number> readSamples()
      read the Samples that were stored as this component in a TOML file.
      Returns:
      the Samples object