Added/fixed documentation
This commit is contained in:
parent
30c7f7f1c7
commit
5ac9feb9e2
|
|
@ -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.
|
||||
* This relation is abstract because if not specialised it does not add any semantic of
|
||||
* 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.
|
||||
*
|
||||
* The identified specialisations are
|
||||
|
|
@ -33,11 +33,11 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
|
|||
@JsonDeserialize(as=HasContactImpl.class)
|
||||
@TypeMetadata(
|
||||
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 "
|
||||
+ "the resource with the target {@link ContactFacet}.\n"
|
||||
+ "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: "
|
||||
+ "{@link HasContributor}, {@link HasCreator}, {@link HasCurator}, "
|
||||
+ "{@link HasDeveloper}, {@link HasMaintainer}, {@link HasManager} and {@link HasOwner}.",
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasContribut
|
|||
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -14,15 +14,16 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasCoverageI
|
|||
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
|
||||
* 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
|
||||
* 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
|
||||
* no need to understand the value or the schema of the coverage.
|
||||
* 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.
|
||||
* 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 CoverageFacet.
|
||||
* have been defined to refines the reason of using the {@link CoverageFacet}.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasCreatorIm
|
|||
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasCuratorIm
|
|||
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasDeveloper
|
|||
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasMaintaine
|
|||
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,
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasManagerIm
|
|||
import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
|
|||
* relating the resource with the target {@link MemoryFacet}.
|
||||
*
|
||||
* 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.)
|
||||
*
|
||||
* 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(
|
||||
name = HasMemory.NAME,
|
||||
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"
|
||||
+ "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.)."
|
||||
+ "This relation is abstract because if not specialised it does not add any semantic of relating the "
|
||||
+ "resource with the target {@link MemoryFacet}.\n"
|
||||
+ "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"
|
||||
+ "For example, to discriminate between Solid State Disk and Magnetic Rotative.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasOwnerImpl
|
|||
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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
name = HasOwner.NAME,
|
||||
description = "HasOwner indicates that the target ContactFacet contains the information related "
|
||||
+ "to the owner of the source resources, e.g., the contact points of the owner of dataset.",
|
||||
description = "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.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasPersisten
|
|||
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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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"
|
||||
+ "This type of memory is also known as secondary memory, external memory, auxiliary "
|
||||
+ "storage, or secondary storage.\n"
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasSpatialCo
|
|||
import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFacet;
|
||||
|
||||
/**
|
||||
* HasSpatialCoverage indicates that the target CoverageFacet indicates a spatial coverage information,
|
||||
* e.g., the geographic area indication for the dataset.
|
||||
* HasSpatialCoverage indicates that the target {@link CoverageFacet} indicates a spatial
|
||||
* coverage information, e.g., the geographic area indication for the dataset.
|
||||
*
|
||||
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#HasSpatialCoverage
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
|
|
@ -21,7 +21,8 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFace
|
|||
@JsonDeserialize(as=HasSpatialCoverageImpl.class)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasTemporalC
|
|||
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.
|
||||
*
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.HasVolatileM
|
|||
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.
|
||||
* 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)
|
||||
@TypeMetadata(
|
||||
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"
|
||||
+ "Volatile memory is also known as main memory, internal memory or primary storage.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
|
|
|
|||
|
|
@ -11,14 +11,15 @@ 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.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.
|
||||
* IsIdentifiedBy indicates that the target facet represents a sort of
|
||||
* 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.
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
|
|
@ -28,9 +29,9 @@ import org.gcube.resourcemanagement.model.impl.relations.consistsof.IsIdentified
|
|||
@JsonDeserialize(as=IsIdentifiedByImpl.class)
|
||||
@TypeMetadata(
|
||||
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"
|
||||
+ "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.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
|
|
|
|||
|
|
@ -13,14 +13,16 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.LegalBody
|
|||
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
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
@JsonDeserialize(as=BelongsToImpl.class)
|
||||
@TypeMetadata(
|
||||
name = BelongsTo.NAME,
|
||||
description = "",
|
||||
name = BelongsTo.NAME,
|
||||
description = "BelongsTo indicates that a {@link Person} belong to the target {@link LegalBody}.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -13,14 +13,16 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
|
|||
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
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
@JsonDeserialize(as=IsCompliantWithImpl.class)
|
||||
@TypeMetadata(
|
||||
name = IsCompliantWith.NAME,
|
||||
description = "",
|
||||
name = IsCompliantWith.NAME,
|
||||
description = "IsCompliantWith is used to indicated a {@link Dataset} compliant with a {@link Schema}.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
|
|||
*/
|
||||
@JsonDeserialize(as=IsConfiguredByImpl.class)
|
||||
@TypeMetadata(
|
||||
name = IsConfiguredBy.NAME,
|
||||
description = "The relation IsConfiguredBy indicates that the source "
|
||||
name = IsConfiguredBy.NAME,
|
||||
description = "The relation IsConfiguredBy indicates that the source "
|
||||
+ "{@link Software} requires a configuration when it is instantiated.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
|
|
|
|||
|
|
@ -12,14 +12,16 @@ import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.IsCorrelate
|
|||
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
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
@JsonDeserialize(as=IsCorrelatedToImpl.class)
|
||||
@TypeMetadata(
|
||||
name = IsCorrelatedTo.NAME,
|
||||
description = "",
|
||||
name = IsCorrelatedTo.NAME,
|
||||
description = "IsCorrelatedTo relates a {@link Dataset} to another.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -13,14 +13,18 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Configura
|
|||
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
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
@JsonDeserialize(as=IsDerivationOfImpl.class)
|
||||
@TypeMetadata(
|
||||
name = IsDerivationOf.NAME,
|
||||
description = "",
|
||||
name = IsDerivationOf.NAME,
|
||||
description = "IsDerivationOf indicate that the source {@link Configuration} is an "
|
||||
+ "instantiation of the target {@link ConfigurationTemplate}.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -12,14 +12,16 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.ConcreteD
|
|||
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
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
@JsonDeserialize(as=IsPartOfImpl.class)
|
||||
@TypeMetadata(
|
||||
name = IsPartOf.NAME,
|
||||
description = "",
|
||||
name = IsPartOf.NAME,
|
||||
description = "IsPartOf is used when a {@link ConcreteDataset} is part of a {@link Dataset}.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
|
|
@ -13,14 +13,18 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Dataset;
|
|||
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
|
||||
*
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
@JsonDeserialize(as=ManagesImpl.class)
|
||||
@TypeMetadata(
|
||||
name = Manages.NAME,
|
||||
description = "",
|
||||
name = Manages.NAME,
|
||||
description = "Manages indicates that of the source {@link Service} manages the target "
|
||||
+ "{@link Dataset}, e.g. read, manipulate, etc.",
|
||||
version = TypeVersion.MINIMAL_VERSION_STRING
|
||||
)
|
||||
@Change(version = TypeVersion.MINIMAL_VERSION_STRING, description = TypeVersion.MINIMAL_VERSION_DESCRIPTION)
|
||||
|
|
|
|||
Loading…
Reference in New Issue