Package org.fairdatapipeline.api

Class 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 Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void populate_component()  
      Distribution readDistribution()
      read the Distribution that was stored as this component in a TOML file.
      java.lang.Number readEstimate()
      read the Estimate that was stored as this component in a TOML file.
      CleanableFileChannel readFileChannel()
      get the CleanableFileChannel to read directly from the file.
      java.nio.file.Path readLink()
      get the filePath to read from; only for whole_object component
      java.util.List<java.lang.Number> readSamples()
      read the Samples that were stored as this component in a TOML file.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • populate_component

        protected void populate_component()

      • readLink

        public java.nio.file.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 java.io.IOException
        get the CleanableFileChannel to read directly from the file. only for whole_object component.
        Returns:
        CleanableFileChannel the filechannel to read from.
        Throws:
        java.io.IOException - if the file can't be opened.

      • readEstimate

        public java.lang.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 java.util.List<java.lang.Number> readSamples()
        read the Samples that were stored as this component in a TOML file.
        Returns:
        the Samples object