References

Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented.

This chapter for technical references contains the UML diagrams.

They are inspired from

See the Dataverse guide for the API at https://guides.dataverse.org/en/6.0/api/.

The version of ERDG is displayed on each footer page of ERDG and exposed at https://entrepot.recherche.data.gouv.fr/api/info/version.

Once instantiated, DataverseClient is the entry point for the API.

See Result for details about the generic class used to return results of API calls.

Click on the class name to open the page.

---
title: Overview of main classes
---
classDiagram
  DataverseClient *-- DataverseConfiguration
  click DataverseClient href "dataverse/index.html" "Open the page"
  DataverseClient *-- InstanceHandler
  click InstanceHandler href "instance/index.html" "Open the page"
  DataverseClient *-- DataverseHandler
  click DataverseHandler href "dataverse/index.html" "Open the page"
  DataverseClient *-- DatasetHandler
  click DatasetHandler href "dataset/index.html" "Open the page"
  DataverseClient *-- FileHandler
  click FileHandler href "file/index.html" "Open the page"
  DataverseClient *-- TokenHandler
  click TokenHandler href "token/index.html" "Open the page"

  class Result~T,ERR~ {
    +Result~T~ ok(T)$
    +Result~ERR~ err(ERR)$
    +T getOk()
    +ERR getErr()
    +boolean isOk()
    +boolean isErr()
  }
  click Result href "result/index.html" "Open the page"

  class DataverseConfiguration {
    String url
    %% Dataset collection
    String dataverse
    String token
  }

  class Assignment {
    %% eg.: @toto
    +String assignee
    %% TODO set enum "admin", "curator", ...
    +String role
  }

  class DataverseClient {
    -Result~Integer,String~ getDatasetId()
    +Result~Boolean,String~ checkConfiguration()
  }