Improving documentation
This commit is contained in:
parent
5497bfaf6e
commit
0983c65505
|
|
@ -10,7 +10,7 @@ https://openportal.isti.cnr.it/doc?id=people______::470484e51fcb9e307a418c800efc
|
|||
|
||||
If you need to refer to such work you can cite the PhD Thesis.
|
||||
|
||||
.. code:: BibText
|
||||
.. code::
|
||||
|
||||
@phdthesis{frosini2019transactional,
|
||||
title={Transactional REST Information System for Federated Research Infrastructures enabling Virtual Research Environments},
|
||||
|
|
@ -23,7 +23,7 @@ An previous paper about this work is:
|
|||
|
||||
|
||||
|
||||
.. code:: BibText
|
||||
.. code::
|
||||
|
||||
@article{frosini2018facet,
|
||||
title={A Facet-based Open and Extensible Resource Model for Research Data Infrastructures.},
|
||||
|
|
@ -87,7 +87,7 @@ Merriam Webster Dictionary defines facet as “any of the definable aspects that
|
|||
The Free Dictionary defines a facet as “One of numerous aspects, as of a subject” [#FacetFreeDictionaryDef]_ .
|
||||
|
||||
|
||||
....
|
||||
|
||||
Type Attributes
|
||||
===============
|
||||
|
||||
|
|
@ -124,19 +124,76 @@ Regex (Reg)):
|
|||
Basic Types
|
||||
-----------
|
||||
|
||||
.. table:: Basic Types
|
||||
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Type | Java type | Description |
|
||||
+==========+===========================================================================================+===========================================================+
|
||||
| Boolean | <code>java.lang.Boolean</code> or <code>boolean</code> | Handles only the values <em>True</em> or <em>False</em>. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Integer | <code>java.lang.Integer</code> or <code>int</code> or <code>java.math.BigInteger</code> | 32-bit signed Integers. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Short | <code>java.lang.Short</code> or <code>short</code> | Small 16-bit signed integers. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Long | <code>java.lang.Long</code> or <code>long</code> | Big 64-bit signed integers. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Float | <code>java.lang.Float</code> or <code>float</code> | Decimal numbers. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Double | <code>java.lang.Double</code> or <code>double</code> | Decimal numbers with high precision. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Date | <code>java.util.Date</code> | Any date with the precision up to milliseconds. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| String | <code>java.lang.String</code> | Any string as alphanumeric sequence of chars. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Byte | <code>java.lang.Byte</code> or <code>byte</code> | Single byte. useful to store small 8-bit signed integers. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
| Binary | <code>java.lang.Byte[]</code> or <code>byte[]</code> | Can contain any value as byte array. |
|
||||
+----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+
|
||||
|
||||
|
||||
|
||||
Derived Types
|
||||
-----------
|
||||
-------------
|
||||
|
||||
The following are obtained using a String as real type and adding a validation regex.
|
||||
|
||||
.. table:: Derived Types
|
||||
|
||||
+--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Type | Java type | Description |
|
||||
+==============+=============================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
|
||||
| Enum | <code>java.lang.Enum</code> or <code>enum</code> | By default it is represented using the String representation of the Enum. So that the primitive type used will be String. The enumeration is checked by setting <code>Regexpr</code> property. The Regular Expression is auto-generated and it will be something like <code>^(FIRST-ENUM-STRING_REPRESENTATION SECOND-ENUM-STRING_REPRESENTATION... LAST_ENUM_STRING_REPRESENTATION)$</code>. Otherwise (if indicated using an annotation), it can be represented using the Integer value of the Enum. So that the primitive type used will be Integer. The enumeration is checked using <code>Max</code> and <code>Min</code> properties. |
|
||||
+--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| UUID | <code>java.util.UUID</code> | String representation of the UUID. The check is obtained using the regular expression ^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$ |
|
||||
+--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| URL | <code>java.net.URL</code> | String representation of the URL. No check actually. |
|
||||
+--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| URI | <code>java.net.URI</code> | String representation of the URI. No check actually. |
|
||||
+--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| TypeVersion | <code>org.gcube.informationsystem.utils.TypeVersion</code> | A type representing and validating a version in the following format X.X.X Major(Integer).Minor(Integer).Revision(Integer) (e.g 1.0.0, 2.3.0, 2.0.1). The check is obtained using the regular expression '''<code>^[1-9][0-9]{0,}\.(0 |
|
||||
+--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
|
||||
Complex Types
|
||||
-----------
|
||||
-------------
|
||||
|
||||
Any property defined by composing basic types, complex types and other complex types. Any complex type can be defined by extending Property type.
|
||||
|
||||
.. table:: Complex Types
|
||||
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Type | Java type | Description |
|
||||
+===========================+=================================================================================================================+===================================================================================================================================================================+
|
||||
| Property | <code>? extends org.gcube.informationsystem.model.reference.properties.Property</code> | This is an Object contained inside the owner Entity and has no Header. It is reachable only by navigating the owner Entity/Relation. |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| <del>Property list</del> | <del><code>List<? extends org.gcube.informationsystem.model.reference.properties.Property></code></del> | <del>List of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity/Relation.</del> |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| <del>Property set</del> | <del><code>Set<? org.gcube.informationsystem.model.reference.properties.Property></code></del> | <del>Set (no duplicates) of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity/Relation.</del> |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Property map | <code>Map<String, ? extends org.gcube.informationsystem.model.reference.properties.Propertyd></code> | Map of Objects contained inside the owner Entity and have no Header. They are reachable only by navigating the owner Entity/Relation. |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
Property
|
||||
========
|
||||
|
|
|
|||
Loading…
Reference in New Issue