Added/fixed documentation

This commit is contained in:
Luca Frosini 2020-12-22 14:26:38 +01:00
parent 30c7f7f1c7
commit 5ac9feb9e2
22 changed files with 100 additions and 61 deletions

View File

@ -17,7 +17,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
* HasContact is a base relation type to capture the diverse points of contact associated with a resource. * HasContact is a base relation type to capture the diverse points of contact associated with a resource.
* This relation is abstract because if not specialised it does not add any semantic of * This relation is abstract because if not specialised it does not add any semantic of
* relating the resource with the target {@link ContactFacet}. * relating the resource with the target {@link ContactFacet}.
* Instead, every specialisation refines the reason of using the @link ContactFacet} allowing * Instead, every specialisation refines the reason of using the {@link ContactFacet} allowing
* to discriminate between two or more {@link ContactFacet} attached to the same resource. * to discriminate between two or more {@link ContactFacet} attached to the same resource.
* *
* The identified specialisations are * The identified specialisations are
@ -33,11 +33,11 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasContactImpl.class) @JsonDeserialize(as=HasContactImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasContact.NAME, name = HasContact.NAME,
description = "A base relation type to capture the diverse points of contact associated with a resource. " description = "HasContact is a base relation type to capture the diverse points of contact associated with a resource. "
+ "This relation is abstract because if not specialised it does not add any semantic of relating " + "This relation is abstract because if not specialised it does not add any semantic of relating "
+ "the resource with the target {@link ContactFacet}.\n" + "the resource with the target {@link ContactFacet}.\n"
+ "Instead, every specialisation refines the reason of using the " + "Instead, every specialisation refines the reason of using the "
+ "@link ContactFacet} allowing to discriminate between two or more {@link ContactFacet} attached to the same resource." + "{@link ContactFacet} allowing to discriminate between two or more {@link ContactFacet} attached to the same resource."
+ "The identified specialisations are: " + "The identified specialisations are: "
+ "{@link HasContributor}, {@link HasCreator}, {@link HasCurator}, " + "{@link HasContributor}, {@link HasCreator}, {@link HasCurator}, "
+ "{@link HasDeveloper}, {@link HasMaintainer}, {@link HasManager} and {@link HasOwner}.", + "{@link HasDeveloper}, {@link HasMaintainer}, {@link HasManager} and {@link HasOwner}.",

View File

@ -12,9 +12,9 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasContribut
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasContributor indicates that the target ContactFacet contains the information * HasContributor indicates that the target {@link ContactFacet} contains the information
* related to a contributor to the source resource e.g., the contact points of * related to a contributor to the source resource,
* the contributor of software or the contributor of a dataset. * e.g., the contact points of the contributor of software or the contributor of a dataset.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasContributor * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasContributor
* *
@ -23,7 +23,9 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasContributorImpl.class) @JsonDeserialize(as=HasContributorImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasContributor.NAME, name = HasContributor.NAME,
description = "HasContributor indicates that the target ContactFacet contains the information related to a contributor to the source resource e.g., the contact points of the contributor of software or the contributor of a dataset.", description = "HasContributor indicates that the target {@link ContactFacet} contains the information "
+ "related to a contributor to the source resource, e.g., the contact points of the contributor "
+ "of software or the contributor of a dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -14,15 +14,16 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasCoverageI
import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet;
/** /**
* HasCoverage represents the type of coverage that is provided by the CoverageFacet.
* Let consider a dataset containing information regarding the salinity of a specific * Let consider a dataset containing information regarding the salinity of a specific
* ocean area in a certain amount of time. What is essential in the information system is * ocean area in a certain amount of time. What is essential in the Information System is
* not representing the data of the salinity. Instead, to specify the temporal period and the * not representing the data of the salinity. Instead, to specify the temporal period and the
* ocean area the dataset is valid. This information is captured using the same schema * ocean area the dataset is valid. This information is captured using the same schema
* i.e., the CoverageFacet but using different relations to distinguish between them with * i.e., the {@link CoverageFacet} but using different relations to distinguish between them
* no need to understand the value or the schema of the coverage. * with no need to understand the value or the schema of the coverage.
* For such a reason it has been defined the abstract HasCoverage relation and the * For such a reason it has been defined the abstract HasCoverage relation and the
* specialisation {@link HasTemporalCoverage} and {@link HasSpatialCoverage} * specialisation {@link HasTemporalCoverage} and {@link HasSpatialCoverage}
* have been defined to refines the reason of using the CoverageFacet. * have been defined to refines the reason of using the {@link CoverageFacet}.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasCoverage * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasCoverage
* *
@ -32,7 +33,16 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFace
@JsonDeserialize(as=HasCoverageImpl.class) @JsonDeserialize(as=HasCoverageImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasCoverage.NAME, name = HasCoverage.NAME,
description = "HasCoverage represents the type of coverage that is provided by the CoverageFacet.", description = "HasCoverage represents the type of coverage that is provided by the CoverageFacet."
+ "Let consider a dataset containing information regarding the salinity of a specific "
+ "ocean area in a certain amount of time. What is essential in the Information System is"
+ "not representing the data of the salinity. Instead, to specify the temporal period and the "
+ "ocean area the dataset is valid. This information is captured using the same schema, "
+ "i.e., the {@link CoverageFacet} but using different relations to distinguish between them "
+ "with no need to understand the value or the schema of the coverage.\n"
+ "For such a reason it has been defined the abstract HasCoverage relation and the "
+ "specialisation {@link HasTemporalCoverage} and {@link HasSpatialCoverage} "
+ "have been defined to refines the reason of using the {@link CoverageFacet}.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasCreatorIm
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasCreator indicates that the target ContactFacet contains the information related to * HasCreator indicates that the target {@link ContactFacet} contains the information related to
* a creator of the source resource e.g., the contact points of the creator of a dataset. * a creator of the source resource, e.g., the contact points of the creator of a dataset.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasCreator * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasCreator
* *
@ -22,7 +22,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasCreatorImpl.class) @JsonDeserialize(as=HasCreatorImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasCreator.NAME, name = HasCreator.NAME,
description = "HasCreator indicates that the target ContactFacet contains the information related to a creator of the source resource e.g., the contact points of the creator of a dataset.", description = "HasCreator indicates that the target {@link ContactFacet} contains the information related "
+ "to a creator of the source resource, e.g., the contact points of the creator of a dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasCuratorIm
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasCurator indicates that the target ContactFacet contains the information related to * HasCurator indicates that the target {@link ContactFacet} contains the information related to
* a curator of the source resource e.g., the contact points of the curator of a dataset. * a curator of the source resource, e.g., the contact points of the curator of a dataset.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasCurator * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasCurator
* *
@ -22,7 +22,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasCuratorImpl.class) @JsonDeserialize(as=HasCuratorImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasCurator.NAME, name = HasCurator.NAME,
description = "HasCurator indicates that the target ContactFacet contains the information related to a curator of the source resource e.g., the contact points of the curator of a dataset.", description = "HasCurator indicates that the target {@link ContactFacet} contains the information related "
+ "to a curator of the source resource, e.g., the contact points of the curator of a dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasDeveloper
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasDeveloper indicates that the target ContactFacet contains the information related to a * HasDeveloper indicates that the target {@link ContactFacet} contains the information related to a
* developer of the source resource e.g., the contact points ofthe developer of a software. * developer of the source resource e.g., the contact points of the developer of a software.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasDeveloper * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasDeveloper
* *
@ -22,7 +22,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasDeveloperImpl.class) @JsonDeserialize(as=HasDeveloperImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasDeveloper.NAME, name = HasDeveloper.NAME,
description = "HasDeveloper indicates that the target ContactFacet contains the information related to a developer of the source resource e.g., the contact points ofthe developer of a software.", description = "HasDeveloper indicates that the target {@link ContactFacet} contains the information related "
+ "to a developer of the source resource e.g., the contact points ofthe developer of a software.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasMaintaine
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasDeveloper indicates that the target ContactFacet contains the * HasDeveloper indicates that the target {@link ContactFacet} contains the
* information related to a developer of the source resource, * information related to a developer of the source resource,
* e.g., the contact points of the developer of a software. * e.g., the contact points of the developer of a software.
* *
@ -23,7 +23,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasMaintainerImpl.class) @JsonDeserialize(as=HasMaintainerImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasContact.NAME, name = HasContact.NAME,
description = "HasDeveloper indicates that the target ContactFacet contains the information related to a developer of the source resource, e.g., the contact points of the developer of a software.", description = "HasDeveloper indicates that the target {@link ContactFacet} contains the information related "
+ "to a developer of the source resource, e.g., the contact points of the developer of a software.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,9 +12,9 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasManagerIm
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasManager indicates that the target ContactFacet contains the information * HasManager indicates that the target {@link ContactFacet} contains the information
* related to a manager of the source Resource e.g., the contact points of the * related to a manager of the source resource,
* manager of a research infrastructure or a data centre. * e.g., the contact points of the manager of a research infrastructure or a data centre.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasManager * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasManager
* *
@ -23,7 +23,9 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasManagerImpl.class) @JsonDeserialize(as=HasManagerImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasManager.NAME, name = HasManager.NAME,
description = "HasManager indicates that the target ContactFacet contains the information related to a manager of the source Resource e.g., the contact points of the manager of a research infrastructure or a data centre.", description = "HasManager indicates that the target {@link ContactFacet} contains the information related "
+ "to a manager of the source resource, "
+ "e.g., the contact points of the manager of a research infrastructure or a data centre.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -19,7 +19,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
* relating the resource with the target {@link MemoryFacet}. * relating the resource with the target {@link MemoryFacet}.
* *
* It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory} * It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory}
* to clarify the semantics of the memory. (Any resource describing a computing machine must have at least * to clarify the semantics of the memory (any resource describing a computing machine must have at least
* two types of memories, i.e., persistent and volatile.) * two types of memories, i.e., persistent and volatile.)
* *
* We do not exclude other specialisation required by services to select the appropriated memory better. * We do not exclude other specialisation required by services to select the appropriated memory better.
@ -34,9 +34,11 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
@TypeMetadata( @TypeMetadata(
name = HasMemory.NAME, name = HasMemory.NAME,
description = "HasMemory is a base relation type to capture the diverse type of memories associated with a resource.\n" description = "HasMemory is a base relation type to capture the diverse type of memories associated with a resource.\n"
+ "This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target {@link MemoryFacet}.\n" + "This relation is abstract because if not specialised it does not add any semantic of relating the "
+ "It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory} to clarify the semantics of the memory." + "resource with the target {@link MemoryFacet}.\n"
+ "(Any resource describing a computing machine must have at least two types of memories, i.e., persistent and volatile.)." + "It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory} "
+ "to clarify the semantics of the memory "
+ "(any resource describing a computing machine must have at least two types of memories, i.e., persistent and volatile)."
+ "We do not exclude other specialisation required by services to select the appropriated memory better.\n" + "We do not exclude other specialisation required by services to select the appropriated memory better.\n"
+ "For example, to discriminate between Solid State Disk and Magnetic Rotative.", + "For example, to discriminate between Solid State Disk and Magnetic Rotative.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING

View File

@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasOwnerImpl
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
/** /**
* HasOwner indicates that the target ContactFacet contains the information related to * HasOwner indicates that the target {@link ContactFacet} contains the information related to
* the owner of the source resource, e.g., the contact points of the owner of dataset. * the owner of the source resource, e.g., the contact points of the owner of dataset.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasOwner * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasOwner
@ -22,8 +22,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
@JsonDeserialize(as=HasOwnerImpl.class) @JsonDeserialize(as=HasOwnerImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasOwner.NAME, name = HasOwner.NAME,
description = "HasOwner indicates that the target ContactFacet contains the information related " description = "HasOwner indicates that the target {@link ContactFacet} contains the information related "
+ "to the owner of the source resources, e.g., the contact points of the owner of dataset.", + "to the owner of the source resource, e.g., the contact points of the owner of dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasPersisten
import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
/** /**
* HasPersistentMemory indicates that the target MemoryFacet indicates a non-volatile * HasPersistentMemory indicates that the target {@link MemoryFacet} indicates a non-volatile
* memory, i.e., a memory which does not lose the data when the device is powered down. * memory, i.e., a memory which does not lose the data when the device is powered down.
* *
* This type of memory is also known as secondary memory, external memory, auxiliary * This type of memory is also known as secondary memory, external memory, auxiliary
@ -32,7 +32,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
@JsonDeserialize(as=HasPersistentMemoryImpl.class) @JsonDeserialize(as=HasPersistentMemoryImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasPersistentMemory.NAME, name = HasPersistentMemory.NAME,
description = "HasPersistentMemory indicates that the target MemoryFacet indicates a non-volatile " description = "HasPersistentMemory indicates that the target {@link MemoryFacet} indicates a non-volatile "
+ " memory, i.e., a memory which does not lose the data when the device is powered down.\n" + " memory, i.e., a memory which does not lose the data when the device is powered down.\n"
+ "This type of memory is also known as secondary memory, external memory, auxiliary " + "This type of memory is also known as secondary memory, external memory, auxiliary "
+ "storage, or secondary storage.\n" + "storage, or secondary storage.\n"

View File

@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasSpatialCo
import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet;
/** /**
* HasSpatialCoverage indicates that the target CoverageFacet indicates a spatial coverage information, * HasSpatialCoverage indicates that the target {@link CoverageFacet} indicates a spatial
* e.g., the geographic area indication for the dataset. * coverage information, e.g., the geographic area indication for the dataset.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasSpatialCoverage * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasSpatialCoverage
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -21,7 +21,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFace
@JsonDeserialize(as=HasSpatialCoverageImpl.class) @JsonDeserialize(as=HasSpatialCoverageImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasSpatialCoverage.NAME, name = HasSpatialCoverage.NAME,
description = "HasSpatialCoverage indicates that the target CoverageFacet indicates a spatial coverage information, e.g., the geographic area indication for the dataset.", description = "HasSpatialCoverage indicates that the target {@link CoverageFacet} indicates "
+ "a spatial coverage information, e.g., the geographic area indication for the dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasTemporalC
import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet;
/** /**
* HasTemporalCoverage indicates that the target CoverageFacet indicates a temporal * HasTemporalCoverage indicates that the target {@link CoverageFacet} indicates a temporal
* coverage information, e.g., the temporal period indication for the dataset. * coverage information, e.g., the temporal period indication for the dataset.
* *
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasTemporalCoverage * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasTemporalCoverage
@ -22,7 +22,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFace
@JsonDeserialize(as=HasTemporalCoverageImpl.class) @JsonDeserialize(as=HasTemporalCoverageImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasTemporalCoverage.NAME, name = HasTemporalCoverage.NAME,
description = "HasTemporalCoverage indicates that the target CoverageFacet indicates a temporal coverage information e.g., the temporal period indication for the dataset.", description = "HasTemporalCoverage indicates that the target {@link CoverageFacet} indicates "
+ "a temporal coverage information e.g., the temporal period indication for the dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasVolatileM
import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet; import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
/** /**
* HasVolatileMemory indicates that the target MemoryFacet is a volatile memory, * HasVolatileMemory indicates that the target {@link MemoryFacet} is a volatile memory,
* i.e., a memory which requires power to maintain the stored information. * i.e., a memory which requires power to maintain the stored information.
* Volatile memory is also known as main memory, internal memory or primary storage. * Volatile memory is also known as main memory, internal memory or primary storage.
* *
@ -23,7 +23,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
@JsonDeserialize(as=HasVolatileMemoryImpl.class) @JsonDeserialize(as=HasVolatileMemoryImpl.class)
@TypeMetadata( @TypeMetadata(
name = HasVolatileMemory.NAME, name = HasVolatileMemory.NAME,
description = "HasVolatileMemory indicates that the target MemoryFacet is a volatile memory, " description = "HasVolatileMemory indicates that the target {@link MemoryFacet} is a volatile memory, "
+ "i.e., a memory which requires power to maintain the stored information.\n" + "i.e., a memory which requires power to maintain the stored information.\n"
+ "Volatile memory is also known as main memory, internal memory or primary storage.", + "Volatile memory is also known as main memory, internal memory or primary storage.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING

View File

@ -11,14 +11,15 @@ import org.gcube.informationsystem.types.reference.Change;
import org.gcube.informationsystem.types.reference.TypeMetadata; import org.gcube.informationsystem.types.reference.TypeMetadata;
import org.gcube.informationsystem.utils.TypeVersion; import org.gcube.informationsystem.utils.TypeVersion;
import org.gcube.resourcemanagement.model.impl.relations.consistsof.IsIdentifiedByImpl; import org.gcube.resourcemanagement.model.impl.relations.consistsof.IsIdentifiedByImpl;
import org.gcube.resourcemanagement.model.reference.entities.resources.GCubeResource;
/** /**
* Each gCube resource has been defined to have at least a Facet linked with * Each {@link GCubeResource} has been defined to have at least a facet linked with
* an IsIdentifiedBy relation. * an IsIdentifiedBy relation.
* IsIdentifiedBy indicates that the target facet represents a sort of * IsIdentifiedBy indicates that the target facet represents a sort of
* identification for the source resource. * identification for the source resource.
* *
* For instance, a software can consist of one or more SoftwareFacets but the one * For instance, a software can consist of one or more {@link SoftwareFacet} but the one
* related with IsIdentifiedBy represents the identify of the software. * related with IsIdentifiedBy represents the identify of the software.
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -28,9 +29,9 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.IsIdentified
@JsonDeserialize(as=IsIdentifiedByImpl.class) @JsonDeserialize(as=IsIdentifiedByImpl.class)
@TypeMetadata( @TypeMetadata(
name = IsIdentifiedBy.NAME, name = IsIdentifiedBy.NAME,
description = "Each gCube resource has been defined to have at least a Facet linked with an IsIdentifiedBy relation.\n" description = "Each {@link GCubeResource} has been defined to have at least a facet linked with an IsIdentifiedBy relation.\n"
+ "IsIdentifiedBy indicates that the target facet represents a sort of identification for the source resource.\n" + "IsIdentifiedBy indicates that the target facet represents a sort of identification for the source resource.\n"
+ "For instance, a software can consist of one or more SoftwareFacets but the one related with " + "For instance, a software can consist of one or more {@link SoftwareFacet} but the one related with "
+ "IsIdentifiedBy represents the identify of the software.", + "IsIdentifiedBy represents the identify of the software.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )

View File

@ -13,6 +13,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.LegalBody
import org.gcube.resourcemanagement.model.reference.entities.resources.Person; import org.gcube.resourcemanagement.model.reference.entities.resources.Person;
/** /**
* BelongsTo indicates that a {@link Person} belong to the target {@link LegalBody}.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#BelongsTo * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#BelongsTo
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -20,7 +22,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Person;
@JsonDeserialize(as=BelongsToImpl.class) @JsonDeserialize(as=BelongsToImpl.class)
@TypeMetadata( @TypeMetadata(
name = BelongsTo.NAME, name = BelongsTo.NAME,
description = "", description = "BelongsTo indicates that a {@link Person} belong to the target {@link LegalBody}.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -13,6 +13,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
import org.gcube.resourcemanagement.model.reference.entities.resources.Schema; import org.gcube.resourcemanagement.model.reference.entities.resources.Schema;
/** /**
* IsCompliantWith is used to indicated a {@link Dataset} compliant with a {@link Schema}.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCompliantWith * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCompliantWith
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -20,7 +22,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Schema;
@JsonDeserialize(as=IsCompliantWithImpl.class) @JsonDeserialize(as=IsCompliantWithImpl.class)
@TypeMetadata( @TypeMetadata(
name = IsCompliantWith.NAME, name = IsCompliantWith.NAME,
description = "", description = "IsCompliantWith is used to indicated a {@link Dataset} compliant with a {@link Schema}.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,6 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.IsCorrelate
import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset; import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
/** /**
* IsCorrelatedTo relates a {@link Dataset} to another.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCorrelatedTo * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsCorrelatedTo
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -19,7 +21,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
@JsonDeserialize(as=IsCorrelatedToImpl.class) @JsonDeserialize(as=IsCorrelatedToImpl.class)
@TypeMetadata( @TypeMetadata(
name = IsCorrelatedTo.NAME, name = IsCorrelatedTo.NAME,
description = "", description = "IsCorrelatedTo relates a {@link Dataset} to another.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -13,6 +13,9 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Configura
import org.gcube.resourcemanagement.model.reference.entities.resources.ConfigurationTemplate; import org.gcube.resourcemanagement.model.reference.entities.resources.ConfigurationTemplate;
/** /**
* IsDerivationOf indicate that the source {@link Configuration} is an instantiation of
* the target {@link ConfigurationTemplate}.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsDerivationOf * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsDerivationOf
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -20,7 +23,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Configura
@JsonDeserialize(as=IsDerivationOfImpl.class) @JsonDeserialize(as=IsDerivationOfImpl.class)
@TypeMetadata( @TypeMetadata(
name = IsDerivationOf.NAME, name = IsDerivationOf.NAME,
description = "", description = "IsDerivationOf indicate that the source {@link Configuration} is an "
+ "instantiation of the target {@link ConfigurationTemplate}.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -12,6 +12,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.ConcreteD
import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset; import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
/** /**
* IsPartOf is used when a {@link ConcreteDataset} is part of a {@link Dataset}.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsPartOf * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#IsPartOf
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -19,7 +21,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
@JsonDeserialize(as=IsPartOfImpl.class) @JsonDeserialize(as=IsPartOfImpl.class)
@TypeMetadata( @TypeMetadata(
name = IsPartOf.NAME, name = IsPartOf.NAME,
description = "", description = "IsPartOf is used when a {@link ConcreteDataset} is part of a {@link Dataset}.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)

View File

@ -13,6 +13,9 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
import org.gcube.resourcemanagement.model.reference.entities.resources.Service; import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
/** /**
* Manages indicates that of the source {@link Service} manages the target
* {@link Dataset}, e.g. read, manipulate, etc.
*
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Manages * https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Manages
* *
* @author Luca Frosini (ISTI - CNR) * @author Luca Frosini (ISTI - CNR)
@ -20,7 +23,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
@JsonDeserialize(as=ManagesImpl.class) @JsonDeserialize(as=ManagesImpl.class)
@TypeMetadata( @TypeMetadata(
name = Manages.NAME, name = Manages.NAME,
description = "", description = "Manages indicates that of the source {@link Service} manages the target "
+ "{@link Dataset}, e.g. read, manipulate, etc.",
version = TypeVersion.MINIMAL_VERSION_STRING version = TypeVersion.MINIMAL_VERSION_STRING
) )
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION) @Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)