Interface ProgressInterface

All Known Implementing Classes:
ECpdsPlugin
public interface ProgressInterface
ECMWF Product Data Store (OpenECPDS) Project.
Since:
2024-07-01
Version:
6.7.7
Author:
Laurent Gougeon - syi@ecmwf.int, ECMWF.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getByteSent()
    Gets the byte sent.
    long
    getDataFileId()
    Gets the data file id.
    default String
    getDestinationName()
    Gets the name of the Destination this retrieval is for, if applicable.
    default long
    getDuration()
    Gets the total duration, in milliseconds, since this retrieval started.
    default long
    getFileSize()
    Gets the total size, in bytes, of the file being retrieved.
    String
    getRoot()
    Gets the root.
    default Host
    getSourceHost()
    Gets the source Host used for this retrieval (e.g. the Acquisition Host it is being pulled from), if applicable.
    default boolean
    isAcquisition()
    Whether this retrieval is a genuine Acquisition (i.e. from an Acquisition Host), as opposed to e.g. a Dissemination-side backup/source pull which is not shown as an Acquisition on the "Live ECPDS Earth" globe.
    void
    update(String root, long byteSent)
    Update progress.

  • Method Details

    • getDataFileId

      long getDataFileId()
      Gets the data file id.
      Returns:
      the data file id

    • getRoot

      String getRoot()
      Gets the root.
      Returns:
      the root

    • getByteSent

      long getByteSent()
      Gets the byte sent.
      Returns:
      the byte sent

    • update

      void update(String root, long byteSent)
      Update progress.
      Parameters:
      root - the root
      byteSent - the byte sent

    • getDestinationName

      default String getDestinationName()
      Gets the name of the Destination this retrieval is for, if applicable. Used by the "Live ECPDS Earth" globe visualisation to label/attribute Acquisition retrieval samples; not every implementation is tied to a Destination.
      Returns:
      the destination name, or null if not applicable/known

    • getSourceHost

      default Host getSourceHost()
      Gets the source Host used for this retrieval (e.g. the Acquisition Host it is being pulled from), if applicable. Used by the "Live ECPDS Earth" globe visualisation to geolocate/label Acquisition retrieval samples.
      Returns:
      the source host, or null if not applicable/known

    • isAcquisition

      default boolean isAcquisition()
      Whether this retrieval is a genuine Acquisition (i.e. from an Acquisition Host), as opposed to e.g. a Dissemination-side backup/source pull which is not shown as an Acquisition on the "Live ECPDS Earth" globe.
      Returns:
      true, if this is an Acquisition retrieval

    • getDuration

      default long getDuration()
      Gets the total duration, in milliseconds, since this retrieval started.
      Returns:
      the duration, or 0 if not applicable/known

    • getFileSize

      default long getFileSize()
      Gets the total size, in bytes, of the file being retrieved.
      Returns:
      the file size, or -1 if not applicable/known