gCubeSystem
/
gcube-model
16
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documenting types

This commit is contained in:
Luca Frosini 2020-12-21 14:56:46 +01:00
parent 9438dd07fb
commit 94c85b4a5f
25 changed files with 111 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Actor.java
View File

@ -16,12 +16,24 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactReferenceFacet;
import org.gcube.resourcemanagement.model.reference.relations.consistsof.HasContact;
import org.gcube.resourcemanagement.model.reference.relations.consistsof.IsIdentifiedBy;
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.BelongsTo;
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Involves;
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsOwnedBy;
/**
* @author Luca Frosini (ISTI - CNR)
* Actor (Abstract) is any entity (human or machine) playing an active role in the infrastructure.
* Actor has two specialisations, {@link LegalBody} which represent any legal entity, and
* {@link Person} which is any human playing the role of Actor.
* An Actor can belong to a {@link LegalBody} and this is expressed using the defined
* {@link BelongsTo} relation
*
* Actor has similar meaning of E39_Actor defined in CDOC-CRM.
* Similarly LegalBody and Person have similar meaning of
* E40_Legal_Body and E21_Person respectively.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Actor
*
* @author Luca Frosini (ISTI - CNR)
*/
@Abstract
@JsonDeserialize(as=ActorImpl.class)
@ -38,7 +50,10 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsOwne
)
@TypeMetadata(
name = Actor.NAME,
description = "Any entity (human or machine) playing an active role.",
description = "Actor (Abstract) is any entity (human or machine) playing an active role in the infrastructure.\n"
+ "Actor has two specialisations, {@link LegalBody} which represent any legal entity, "
+ "and {@link Person} which is any human playing the role of Actor.\n"
+ "An Actor can belong to a {@link LegalBody} and this is expressed using the defined {@link BelongsTo} relation.",
version = TypeVersion.MINIMAL_VERSION_STRING
)
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

9
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/ConcreteDataset.java
View File

@ -18,8 +18,12 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsPart
/**
* @author Luca Frosini (ISTI - CNR)
* ConcreteDataset is any incarnation/manifestation of a dataset or part of it.
* The relation {@link IsPartOf} is used when a ConcreteDataset is part of a {@link Dataset}.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Concrete_Dataset
*
* @author Luca Frosini (ISTI - CNR)
*/
@JsonDeserialize(as=ConcreteDatasetImpl.class)
@ResourceSchema(
@ -33,7 +37,8 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsPart
)
@TypeMetadata(
name = ConcreteDataset.NAME,
description = "Any incarnation/manifestation of a dataset or part of it",
description = "ConcreteDataset is any incarnation/manifestation of a dataset or part of it.\n"
+ "The relation {@link IsPartOf} is used when a ConcreteDataset is part of a {@link Dataset}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

13
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Dataset.java
View File

@ -37,8 +37,15 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsPart
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Manages;
/**
* @author Luca Frosini (ISTI - CNR)
* A Dataset is a set of digital objects representing data and treated collectively as a unit.
* It is the key resource of a HDI, even more, it is the reason the HDI exists.
* A Dataset can be correlated to another Dataset by using {@link IsCorrelatedTo} relation.
*
* Dataset has similar meaning of PE18_Dataset defined in PARTHENOS Entities Model (PE Model).
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Dataset
*
* @author Luca Frosini (ISTI - CNR)
*/
@JsonDeserialize(as = DatasetImpl.class)
@ResourceSchema(
@ -70,7 +77,9 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Manage
)
@TypeMetadata(
name = Dataset.NAME,
description = "Any set of digital objects representing data and treated collectively as a unit.",
description = "A Dataset is a set of digital objects representing data and treated collectively as a unit.\n"
+ "It is the key resource of a HDI, even more, it is the reason the HDI exists.\n"
+ "A Dataset can be correlated to another Dataset by using {@link IsCorrelatedTo} relation.",
version = TypeVersion.MINIMAL_VERSION_STRING
)
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

7
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/LegalBody.java
View File

@ -14,8 +14,11 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Belong
/**
* @author Luca Frosini (ISTI - CNR)
* LegalBody represents any legal entity playing the role of an Actor.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Legal_Body
*
* @author Luca Frosini (ISTI - CNR)
*/
@JsonDeserialize(as=LegalBodyImpl.class)
@ResourceSchema(
@ -25,7 +28,7 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Belong
)
@TypeMetadata(
name = LegalBody.NAME,
description = "A legal entity playing the role of an Actor.",
description = "LegalBody represents any legal entity playing the role of an Actor.",
version = TypeVersion.MINIMAL_VERSION_STRING
)
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

7
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Person.java
View File

@ -13,8 +13,11 @@ import org.gcube.resourcemanagement.model.impl.entities.resources.PersonImpl;
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.BelongsTo;
/**
* @author Luca Frosini (ISTI - CNR)
* Person represents any human playing the role of Actor.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Person
*
* @author Luca Frosini (ISTI - CNR)
*/
@JsonDeserialize(as = PersonImpl.class)
@ResourceSchema(
@ -24,7 +27,7 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Belong
)
@TypeMetadata(
name = Person.NAME,
description = "Any human playing the role of Actor.",
description = "Person represents any human playing the role of Actor.",
version = TypeVersion.MINIMAL_VERSION_STRING
)
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Activates.java
View File

@ -12,12 +12,13 @@ import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.ActivatesIm
import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Activates
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#activates
*/
@JsonDeserialize(as=ActivatesImpl.class)
@TypeMetadata(
name = .NAME,
name = Activates.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/BelongsTo.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.LegalBody
import org.gcube.resourcemanagement.model.reference.entities.resources.Person;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#BelongsTo
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#belongsTo
*/
@JsonDeserialize(as=BelongsToImpl.class)
@TypeMetadata(
name = .NAME,
name = BelongsTo.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

8
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/CallsFor.java
View File

@ -5,16 +5,20 @@ package org.gcube.resourcemanagement.model.reference.relations.isrelatedto;
import org.gcube.com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.gcube.informationsystem.model.reference.relations.IsRelatedTo;
import org.gcube.informationsystem.types.reference.Change;
import org.gcube.informationsystem.types.reference.TypeMetadata;
import org.gcube.informationsystem.utils.TypeVersion;
import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.CallsForImpl;
import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#CallsFor
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#callsFor
*/
@JsonDeserialize(as=CallsForImpl.class)
@TypeMetadata(
name = .NAME,
name = CallsFor.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Demands.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
import org.gcube.resourcemanagement.model.reference.entities.resources.VirtualService;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Demands
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#demands
*/
@JsonDeserialize(as=DemandsImpl.class)
@TypeMetadata(
name = .NAME,
name = Demands.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/DependsOn.java
View File

@ -12,12 +12,13 @@ import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.DependsOnIm
import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#DependsOn
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#dependsOn
*/
@JsonDeserialize(as = DependsOnImpl.class)
@TypeMetadata(
name = .NAME,
name = DependsOn.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

8
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Discovers.java
View File

@ -4,16 +4,20 @@
package org.gcube.resourcemanagement.model.reference.relations.isrelatedto;
import org.gcube.com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.gcube.informationsystem.types.reference.Change;
import org.gcube.informationsystem.types.reference.TypeMetadata;
import org.gcube.informationsystem.utils.TypeVersion;
import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.DiscoversImpl;
import org.gcube.resourcemanagement.model.reference.entities.resources.EService;
/**
* * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Discovers
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#discovers
*/
@JsonDeserialize(as=DiscoversImpl.class)
@TypeMetadata(
name = .NAME,
name = Discovers.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Enables.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Enables
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#enables
*/
@JsonDeserialize(as=EnablesImpl.class)
@TypeMetadata(
name = .NAME,
name = Enables.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Hosts.java
View File

@ -14,12 +14,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Site;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Hosts
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#hosts
*/
@JsonDeserialize(as=HostsImpl.class)
@TypeMetadata(
name = .NAME,
name = Hosts.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Involves.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Actor;
import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Involves
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#involves
*/
@JsonDeserialize(as=InvolvesImpl.class)
@TypeMetadata(
name = .NAME,
name = Involves.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsCompliantWith.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
import org.gcube.resourcemanagement.model.reference.entities.resources.Schema;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCompliantWith
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isCompliantWith
*/
@JsonDeserialize(as=IsCompliantWithImpl.class)
@TypeMetadata(
name = .NAME,
name = IsCompliantWith.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsConfiguredBy.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Configura
import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsConfiguredBy
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isConfiguredBy
*/
@JsonDeserialize(as=IsConfiguredByImpl.class)
@TypeMetadata(
name = .NAME,
name = IsConfiguredBy.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsCorrelatedTo.java
View File

@ -12,12 +12,13 @@ import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.IsCorrelate
import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCorrelatedTo
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isCorrelatedTo
*/
@JsonDeserialize(as=IsCorrelatedToImpl.class)
@TypeMetadata(
name = .NAME,
name = IsCorrelatedTo.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsCustomizedBy.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Configura
import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCustomizedBy
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isCustomizedBy
*/
@JsonDeserialize(as=IsCustomizedByImpl.class)
@TypeMetadata(
name = .NAME,
name = IsCustomizedBy.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsDerivationOf.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Configura
import org.gcube.resourcemanagement.model.reference.entities.resources.ConfigurationTemplate;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsDerivationOf
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isDerivationOf
*/
@JsonDeserialize(as=IsDerivationOfImpl.class)
@TypeMetadata(
name = .NAME,
name = IsDerivationOf.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsOwnedBy.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Actor;
import org.gcube.resourcemanagement.model.reference.entities.resources.Site;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsOwnedBy
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isOwnedBy
*/
@JsonDeserialize(as=IsOwnedByImpl.class)
@TypeMetadata(
name = .NAME,
name = IsOwnedBy.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsPartOf.java
View File

@ -12,12 +12,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.ConcreteD
import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsPartOf
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isPartOf
*/
@JsonDeserialize(as=IsPartOfImpl.class)
@TypeMetadata(
name = .NAME,
name = IsPartOf.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/IsPluginOf.java
View File

@ -12,12 +12,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Plugin;
import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsPluginOf
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#isPluginOf
*/
@JsonDeserialize(as = IsPluginOfImpl.class)
@TypeMetadata(
name = .NAME,
name = IsPluginOf.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Manages.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Manages
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#manages
*/
@JsonDeserialize(as=ManagesImpl.class)
@TypeMetadata(
name = .NAME,
name = Manages.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

5
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Requires.java
View File

@ -13,12 +13,13 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Requires
*
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#requires
*/
@JsonDeserialize(as=RequiresImpl.class)
@TypeMetadata(
name = .NAME,
name = Requires.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)

4
src/main/java/org/gcube/resourcemanagement/model/reference/relations/isrelatedto/Uses.java
View File

@ -11,11 +11,13 @@ import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.UsesImpl;
import org.gcube.resourcemanagement.model.reference.entities.resources.EService;
/**
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Uses
*
* @author Luca Frosini (ISTI - CNR)
*/
@JsonDeserialize(as=UsesImpl.class)
@TypeMetadata(
name = .NAME,
name = Uses.NAME,
description = "",
version = TypeVersion.MINIMAL_VERSION_STRING
)