diff --git a/doc/source/ObiDMS_UML.class.violet.html b/doc/source/ObiDMS_UML.class.violet.html index 561f7af..793c933 100644 --- a/doc/source/ObiDMS_UML.class.violet.html +++ b/doc/source/ObiDMS_UML.class.violet.html @@ -20,7 +20,7 @@ - + 1 @@ -48,7 +48,7 @@ - + 1 @@ -66,7 +66,7 @@ - + 1 @@ -84,7 +84,7 @@ - + 1 @@ -102,7 +102,7 @@ - + 1 @@ -120,7 +120,7 @@ - + 1 @@ -138,7 +138,7 @@ - + 1 @@ -156,7 +156,7 @@ - + 1 @@ -181,7 +181,7 @@ comments : str - + 1 @@ -199,7 +199,7 @@ comments : str - + 1 @@ -217,7 +217,7 @@ comments : str - + 1 @@ -235,7 +235,7 @@ comments : str - + 1 @@ -253,7 +253,7 @@ comments : str - + 1 @@ -271,7 +271,7 @@ comments : str - + 1 @@ -289,7 +289,7 @@ comments : str - + 1 @@ -307,7 +307,7 @@ comments : str - + 1 @@ -323,62 +323,67 @@ comments : str + + + + + 1 + + + + + OBIColumnRelease + + + columnAttribute : char* +latestVersion : int + + + + + + + + + + 1 + + + + + .odr extension + + + 255 + 228 + 181 + 255 + + + + + + + 1 + + + + + .odc extension + + + - - + + - - - - - - - 1 - - - - - - - - - - - - - - - 1 - - - - - - - - - - - - - - - 1 - - - - - - - - - - + + - + - + 1 @@ -386,1279 +391,1410 @@ comments : str - - - - + + + + - + - + 1 - - - - - - - + + + + + + + + - + 1 - 1 + - 1 - - + + + - - - - + + + + 1 1 1 - + - - - - + + + + 1 1 1 - + - - - - + + + + 1 - + 1 - + * - + - - - - + + + + 1 - + 1 - + * - + - - - - + + + + - + 1 - + * - + 1 - + - - - - + + + + 1 - + 1 - + 1 - + - - - - + + + + - + 1 - + * - + * - + - - - - + + + + - + 1 - + * - + * - + - - - - + + + + - + 1 - + 1 - + * - + - - - - + + + + 1 - + 1 - + 1 - + - - - - + + + + 1 - + * - + * - + - - - - - - + + + + + + - + 1 - + 1 - + * - + - - - - - + + + + + - + 1 - + 1 - + * - + - - - - - - + + + + + + - + + 1 + + 1 + + * + + + + + + + + + 1 + + 1 + + * + + + + + + + + + 1 + + + + + + + + + 1 + + + + + + + + + + 1 - + + + + + + + + + + + + 1 + + + + + ]]>

- embedded diagram image + embedded diagram image \ No newline at end of file diff --git a/doc/source/formats.rst b/doc/source/formats.rst index 5c07b14..bc481cc 100644 --- a/doc/source/formats.rst +++ b/doc/source/formats.rst @@ -9,6 +9,7 @@ The OBItools3 Data Management System (OBIDMS) An OBIDMS directory consists of : * OBIDMS column files + * OBIDMS release files * an OBIDMS history file @@ -56,12 +57,15 @@ A column of data of the same type. Versioning ---------- -Since OBIDMS column files are read-only, any modification leads to the creation of a new version -of the column file. +OBIDMS column files are read-only, and any modification leads to the creation of a new version +of the column file. That means that one column is stored in one file (if there is only one version) +or more (if there are several versions), and that there is one file per version. The first version of a column file is numbered 1, and each new version increments that number by 1. +The number of the latest version of an OBIDMS column is stored in an `OBIDMS release file `_. + Mandatory columns ----------------- @@ -69,7 +73,22 @@ Mandatory columns Some columns must exist in an OBIDMS directory : * sequence identifiers column - + +OBIDMS release files +==================== + +Each OBIDMS column is associated with an OBIDMS release file that contains the number of the latest +version of the column. + +File name +--------- + +OBIDMS release files are named with the attribute associated to the data contained in the column, and +have the extension ``.odr``. + +Example : ``count.odr`` + + OBIDMS history file =================== diff --git a/doc/source/images/OBIDMS_UML.png b/doc/source/images/OBIDMS_UML.png index c32e0e5..f07d9f7 100644 Binary files a/doc/source/images/OBIDMS_UML.png and b/doc/source/images/OBIDMS_UML.png differ