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

Removed \n from types description

This commit is contained in:
Luca Frosini 2021-09-13 12:57:00 +02:00
parent 64069ccc54
commit 8f948c5068
43 changed files with 97 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/AccessPointFacet.java
View File

@ -27,8 +27,8 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.AccessPointFacetI
@TypeMetadata(
name = AccessPointFacet.NAME,
description = "AccessPointFacet captures information on an 'access point' of a resource, i.e., "
+ "any web-based endpoint to programmatically interact with the resource via a known protocol.\n"
+ "For example, it is used to define the network endpoint to contact the service.\n"
+ "any web-based endpoint to programmatically interact with the resource via a known protocol. "
+ "For example, it is used to define the network endpoint to contact the service. "
+ "The endpoint can expose a well-known high-level protocol.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/CPUFacet.java
View File

@ -26,8 +26,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.HostingNo
@JsonDeserialize(as=CPUFacetImpl.class)
@TypeMetadata(
name = CPUFacet.NAME,
description = "CPUFacet captures information on the Central Processing Unit (CPU) of the resource it is associated with.\n"
+ "A resource which needs to indicate a multi-processor/multi-core CPU will consist of more than one CPUFacet.\n"
description = "CPUFacet captures information on the Central Processing Unit (CPU) of the resource it is associated with. "
+ "A resource which needs to indicate a multi-processor/multi-core CPU will consist of more than one CPUFacet. "
+ "Even if more than one CPUFacet is associated with a resource (i.e., an {@link HostingNode}), we did not find any reason to differentiate the CPUs.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/CapabilityFacet.java
View File

@ -24,7 +24,7 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.CapabilityFacetIm
@JsonDeserialize(as=CapabilityFacetImpl.class)
@TypeMetadata(
name = CapabilityFacet.NAME,
description = "CapabilityFacet captures a defined facility for performing a specified task supported by a given Resource.\n"
description = "CapabilityFacet captures a defined facility for performing a specified task supported by a given Resource. "
+ "It is mainly used to provide a human-readable description of the capabilities of a resource "
+ "(e.g., the support for transactions of an electronic device or some non-functional "
+ "properties of a service like its replicability to support High-Availability (HA)).",

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/CoverageFacet.java
View File

@ -31,7 +31,7 @@ import org.gcube.resourcemanagement.model.reference.properties.ValueSchema;
name = CoverageFacet.NAME,
description = "CoverageFacet captures information on the extent of the resource, "
+ "i.e., any aspect aiming at capturing an indicator of the amount/area "
+ "the resource covers be it a geospatial area, a temporal area, or any other 'area'.\n"
+ "the resource covers be it a geospatial area, a temporal area, or any other 'area'. "
+ "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"

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/DescriptiveMetadataFacet.java
View File

@ -24,7 +24,7 @@ import org.gcube.resourcemanagement.model.reference.properties.ValueSchema;
@JsonDeserialize(as=DescriptiveMetadataFacetImpl.class)
@TypeMetadata(
name = DescriptiveMetadataFacet.NAME,
description = "DescriptiveMetadataFacet captures information on descriptive metadata to be associated with the resource.\n"
description = "DescriptiveMetadataFacet captures information on descriptive metadata to be associated with the resource. "
+ "This facet is mainly used to attach metadata to a Dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/EventFacet.java
View File

@ -27,7 +27,7 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.EventFacetImpl;
@JsonDeserialize(as=EventFacetImpl.class)
@TypeMetadata(
name = EventFacet.NAME,
description = "EventFacet captures information on a certain event/happening characterising the life cycle of the resource.\n"
description = "EventFacet captures information on a certain event/happening characterising the life cycle of the resource. "
+ "Examples of an event are the start time of a virtual machine or the activation time of an electronic service.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/LicenseFacet.java
View File

@ -32,9 +32,9 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.LicenseFacetImpl;
@TypeMetadata(
name = LicenseFacet.NAME,
description = "LicenseFacet captures information on any license associated with the resource to capture "
+ "the policies governing its exploitation and use.\n"
+ "the policies governing its exploitation and use. "
+ "Example of use is the licence of a dataset e.g., Creative Commons Attribution (CC-BY) "
+ "or the licence of software such as GPL.\n"
+ "or the licence of software such as GPL. "
+ "This facet is used to provide for human knowledge, but it is not excluded the usage "
+ "by infrastructure services which enforces the respect of the licence e.g., a service which "
+ "denies the usage of a dataset with Creative Commons Attribution No-Derivatives (CC-BY-ND)"

6
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/LocationFacet.java
View File

@ -28,10 +28,10 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.LocationFacetImpl
@JsonDeserialize(as=LocationFacetImpl.class)
@TypeMetadata(
name = LocationFacet.NAME,
description = "LocationFacet captures information on a physical area characterising the resource it is associated with.\n"
+ "This should not be confused with {@link CoverageFacet}.\n"
description = "LocationFacet captures information on a physical area characterising the resource it is associated with. "
+ "This should not be confused with {@link CoverageFacet}. "
+ "The LocationFacet provides information of a location (eventually using latitude and longitude), "
+ "instead {@link CoverageFacet} provide a way to to define the spatial or the temporal extent the resource represent.\n"
+ "instead {@link CoverageFacet} provide a way to to define the spatial or the temporal extent the resource represent. "
+ "It is mainly used to locate a data centre or to the geographic references of a legal body playing "
+ "the role of an actor in the infrastructure.",
version = TypeVersion.MINIMAL_VERSION_STRING

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/MemoryFacet.java
View File

@ -31,10 +31,10 @@ import org.gcube.resourcemanagement.model.reference.relations.consistsof.HasVola
@JsonDeserialize(as=MemoryFacetImpl.class)
@TypeMetadata(
name = MemoryFacet.NAME,
description = "MemoryFacet captures information on computer memory equipping the resource and its usage.\n"
description = "MemoryFacet captures information on computer memory equipping the resource and its usage. "
+ "Any resource describing a computing machine must have at least two types of memories "
+ "i.e., persistent and volatile. For such a reason, it has been identified the ConsistsOf "
+ "relation called {@link HasMemory}.\n"
+ "relation called {@link HasMemory}. "
+ "It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory} "
+ "to clarify the semantics of the memory.",
version = TypeVersion.MINIMAL_VERSION_STRING

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/NetworkingFacet.java
View File

@ -28,7 +28,7 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.NetworkingFacetIm
@TypeMetadata(
name = NetworkingFacet.NAME,
description = "NetworkingFacet captures information on any (computer) network interface associated with the resource."
+ "It is mainly used to describe the network interface of a host.\n"
+ "It is mainly used to describe the network interface of a host. "
+ "It should not be confused with the {@link AccessPointFacet} "
+ "which instead describes the protocol and the endpoint of a web-based service.",
version = TypeVersion.MINIMAL_VERSION_STRING

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/ProvenanceFacet.java
View File

@ -25,7 +25,7 @@ import org.gcube.resourcemanagement.model.reference.properties.ValueSchema;
@JsonDeserialize(as=ProvenanceFacetImpl.class)
@TypeMetadata(
name = ProvenanceFacet.NAME,
description = "ProvenanceFacet captures information on provenance/lineage of the entire resource.\n"
description = "ProvenanceFacet captures information on provenance/lineage of the entire resource. "
+ "It is mainly used to describe provenance information of a Dataset.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

10
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/SchemaFacet.java
View File

@ -32,12 +32,12 @@ import org.gcube.resourcemanagement.model.reference.properties.ValueSchema;
@TypeMetadata(
name = SchemaFacet.NAME,
description = "SchemaFacet captures information on any schema, "
+ "i.e., a vocabulary used to validate a document associated with a resource.\n"
+ "Examples of schema are JavaScript Object Notation (JSON) schema and XML schema.\n"
+ "JSON schema \"is a vocabulary that allows you to annotate and validate JSON documents\".\n"
+ "i.e., a vocabulary used to validate a document associated with a resource. "
+ "Examples of schema are JavaScript Object Notation (JSON) schema and XML schema. "
+ "JSON schema \"is a vocabulary that allows you to annotate and validate JSON documents\". "
+ "JSON schema is under standardisation by Internet Engineering Task force (IETF) "
+ "(see references at https://json-schema.org/specification.html).\n"
+ "XSD defines the legal building blocks of an XML document.\n"
+ "(see references at https://json-schema.org/specification.html). "
+ "XSD defines the legal building blocks of an XML document. "
+ "DTD defines the structure and the legal elements and attributes of an XML document.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

6
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/SimpleFacet.java
View File

@ -25,10 +25,10 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.SimpleFacetImpl;
@JsonDeserialize(as=SimpleFacetImpl.class)
@TypeMetadata(
name = SimpleFacet.NAME,
description = "A sort of catch all.\nIt does not define any property.\n"
+ "It is mainly used to one or more arbitrary properties to the resource.\n"
description = "A sort of catch all. It does not define any property. "
+ "It is mainly used to one or more arbitrary properties to the resource. "
+ "Before using SimpleFacet a developer should evaluate if it is possible to identify a specific Facet"
+ "to capture the particular aspect of the resource.\n"
+ "to capture the particular aspect of the resource. "
+ "The usage of SimpleFacet should be reduced to the maximum.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/StateFacet.java
View File

@ -25,8 +25,8 @@ import org.gcube.resourcemanagement.model.impl.entities.facets.StateFacetImpl;
@JsonDeserialize(as=StateFacetImpl.class)
@TypeMetadata(
name = StateFacet.NAME,
description = "StateFacet captures information on state to be associated with the resource.\n"
+ "The state is captured by any controlled vocabulary which is an integral part of the facet.\n"
description = "StateFacet captures information on state to be associated with the resource. "
+ "The state is captured by any controlled vocabulary which is an integral part of the facet. "
+ "Examples of usage are the state of service e.g., running or down or "
+ "the state of a virtual machine e.g., activated or unreachable.",
version = TypeVersion.MINIMAL_VERSION_STRING

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

@ -50,9 +50,9 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsOwne
)
@TypeMetadata(
name = Actor.NAME,
description = "Actor (Abstract) is any entity (human or machine) playing an active role in the infrastructure.\n"
description = "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.\n"
+ "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.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

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

@ -36,7 +36,7 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsPart
)
@TypeMetadata(
name = ConcreteDataset.NAME,
description = "ConcreteDataset is any incarnation/manifestation of a dataset or part of it.\n"
description = "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}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Configuration.java
View File

@ -33,7 +33,7 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsDeri
name = Configuration.NAME,
description = "Configuration is a specialisation of {@link ConfigurationTemplate} "
+ "and is an instance of a configuration template characterising "
+ "the behaviour and shape of the resource it is attached to.\n"
+ "the behaviour and shape of the resource it is attached to. "
+ "The Configuration can be related to the template it derives using {@link IsDerivationOf}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

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

@ -78,8 +78,8 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Manage
)
@TypeMetadata(
name = Dataset.NAME,
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"
description = "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.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

12
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/HostingNode.java
View File

@ -64,15 +64,15 @@ import org.gcube.resourcemanagement.model.reference.relations.consistsof.IsIdent
name = HostingNode.NAME,
description = "The HostingNode represent a container capable of managing the lifecycle of "
+ "an electronic service, i.e., being capable to host and operate an {@link EService}. "
+ "Examples are docker, tomcat.\n"
+ "Examples are docker, tomcat. "
+ "A container is a service which is conceived to enable any services respecting "
+ "the container rules to be operative. The container does not typically provide any "
+ "functionality rather than allowing the hosted service to operate.\n"
+ "The HostingNode characterisation in terms of facets reflects the one presented for {@link VirtualMachine}.\n"
+ "functionality rather than allowing the hosted service to operate. "
+ "The HostingNode characterisation in terms of facets reflects the one presented for {@link VirtualMachine}. "
+ "In particular, facets representing memory, CPU and networking interface are used to describe "
+ "the HostingNode when the {@link VirtualMachine} enabling the HostingNode is not represented.\n"
+ "Federated systems can provide virtual machines as resource or containers as resources.\n"
+ "In some cases, the description of a container includes (virtual) hardware information.\n"
+ "the HostingNode when the {@link VirtualMachine} enabling the HostingNode is not represented. "
+ "Federated systems can provide virtual machines as resource or containers as resources. "
+ "In some cases, the description of a container includes (virtual) hardware information. "
+ "It is important to highlight that HostingNode is not a subclass of {@link VirtualMachine}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/RunningPlugin.java
View File

@ -23,7 +23,7 @@ import org.gcube.resourcemanagement.model.impl.entities.resources.RunningPluginI
@TypeMetadata(
name = RunningPlugin.NAME,
description = "RunningPlugin allows differentiating which is the primary service and "
+ "which is an additional capability of a such a service.\n"
+ "which is an additional capability of a such a service. "
+ "Keeping the two concepts separated enables to share a service across "
+ "VREs with a subset of its capabilities.",
version = TypeVersion.MINIMAL_VERSION_STRING

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Schema.java
View File

@ -43,8 +43,8 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsComp
)
@TypeMetadata(
name = Schema.NAME,
description = "Schema is any reference schema used to specify compliant values.\n"
+ "Examples include controlled vocabularies, ontologies, and others.\n"
description = "Schema is any reference schema used to specify compliant values. "
+ "Examples include controlled vocabularies, ontologies, and others. "
+ "This resource is mainly used by {@link Dataset} to evidence that "
+ "is compliant with a Schema by using {@link IsCompliantWith} relation.",
version = TypeVersion.MINIMAL_VERSION_STRING

8
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Service.java
View File

@ -65,12 +65,12 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Requir
)
@TypeMetadata(
name = Service.NAME,
description = "Service (Abstract) represents any typology of service worth registering in the infrastructure.\n"
+ "Service has relations with quite all other resources.\n"
description = "Service (Abstract) represents any typology of service worth registering in the infrastructure. "
+ "Service has relations with quite all other resources. "
+ "If on one side, an Hybrid Data Infrastructure (HDI) is created to manage datasets, "
+ "on the other side the HDI born to manage such datasets digitally.\n"
+ "on the other side the HDI born to manage such datasets digitally. "
+ "We could affirm that datasets and services are the two pillar resources "
+ "around which revolves the entire infrastructure.\n"
+ "around which revolves the entire infrastructure. "
+ "It is important to highlight that Service has a general meaning and must "
+ "not be intended as a network-callable service which is represented instead "
+ "by one of its specialisation called {@link EService}."

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Site.java
View File

@ -56,10 +56,10 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.IsOwne
@TypeMetadata(
name = Site.NAME,
description = "Site is a resource representing the location (physical or virtual) hosting "
+ "the resources associated.\n"
+ "the resources associated. "
+ "Site allows to identify all the services that will be affected by downtime due to a "
+ "scheduled maintenance, as well as the impact on the infrastructure that an accidental"
+ "loss of connectivity could cause.\n"
+ "loss of connectivity could cause. "
+ "This resource allows to study and define the replication scenarios or to provide "
+ "an adequate redundancy level to a VRE.",
version = TypeVersion.MINIMAL_VERSION_STRING

2
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/Software.java
View File

@ -48,7 +48,7 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Requir
)
@TypeMetadata(
name = Software.NAME,
description = "Software is an entity worth being represented for management purposes.\n"
description = "Software is an entity worth being represented for management purposes. "
+ "The relation {@link DependsOn} indicates dependencies between two Software captured for management purposes.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

4
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/VirtualMachine.java
View File

@ -48,8 +48,8 @@ import org.gcube.resourcemanagement.model.reference.relations.consistsof.IsIdent
)
@TypeMetadata(
name = VirtualMachine.NAME,
description = "VirtualMachine (VM) is the typical resource represented in a cloud infrastructure.\n"
+ "It is an emulation of a physical computer which appears to the running operative system as real hardware.\n"
description = "VirtualMachine (VM) is the typical resource represented in a cloud infrastructure. "
+ "It is an emulation of a physical computer which appears to the running operative system as real hardware. "
+ "A VM provides operative system functionality and potentially allows "
+ "to install any software designed for the running operative system.",
version = TypeVersion.MINIMAL_VERSION_STRING

14
src/main/java/org/gcube/resourcemanagement/model/reference/entities/resources/VirtualService.java
View File

@ -54,16 +54,16 @@ import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.Demand
@TypeMetadata(
name = VirtualService.NAME,
description = "VirtualService is an abstract service (non-physically existing service) worth being "
+ "represented as an existing Service for management purposes.\n"
+ "Examples of usage include cases where classes or set of services have to be managed like an existing unit.\n"
+ "represented as an existing Service for management purposes. "
+ "Examples of usage include cases where classes or set of services have to be managed like an existing unit. "
+ "This resource is essential from infrastructure management point of view because "
+ "it allows easily share a pool of services across VREs as a single unit.\n"
+ "it allows easily share a pool of services across VREs as a single unit. "
+ "VirtualService mainly consist of a service definition which uses relations to {@link ConfigurationTemplate}, "
+ "{@link EService}, {@link Software} (using {@link Demands} relation) to properly support the sharing across VREs.\n"
+ "The correct sharing is feasible thanks to the {@link PropagationConstraint} of the model.\n"
+ "The IS provides only the support for resource sharing as a bundle.\n"
+ "{@link EService}, {@link Software} (using {@link Demands} relation) to properly support the sharing across VREs. "
+ "The correct sharing is feasible thanks to the {@link PropagationConstraint} of the model. "
+ "The IS provides only the support for resource sharing as a bundle. "
+ "Instead, the actions required to deploy a {@link Software} are a responsibility "
+ "of the service invoking the sharing operation.\n"
+ "of the service invoking the sharing operation. "
+ "This resource emerged thank to the experience maturated with gCube IS V.1 (gCore Based IS) "
+ "where this resource was represented as a Generic Resource containing "
+ "the list of the resource’s id forming the bundle which often lead to inconsistency.",

2
src/main/java/org/gcube/resourcemanagement/model/reference/relations/consistsof/HasContact.java
View File

@ -35,7 +35,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.ContactFacet
name = HasContact.NAME,
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"
+ "the resource with the target {@link ContactFacet}. "
+ "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: "

2
src/main/java/org/gcube/resourcemanagement/model/reference/relations/consistsof/HasCoverage.java
View File

@ -39,7 +39,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.CoverageFace
+ "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"
+ "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 {@link CoverageFacet}.",

6
src/main/java/org/gcube/resourcemanagement/model/reference/relations/consistsof/HasMemory.java
View File

@ -33,13 +33,13 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
@JsonDeserialize(as=HasMemoryImpl.class)
@TypeMetadata(
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. "
+ "This relation is abstract because if not specialised it does not add any semantic of relating the "
+ "resource with the target {@link MemoryFacet}.\n"
+ "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 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. "
+ "For example, to discriminate between Solid State Disk and Magnetic Rotative.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

6
src/main/java/org/gcube/resourcemanagement/model/reference/relations/consistsof/HasPersistentMemory.java
View File

@ -33,12 +33,12 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
@TypeMetadata(
name = HasPersistentMemory.NAME,
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. "
+ "This type of memory is also known as secondary memory, external memory, auxiliary "
+ "storage, or secondary storage.\n"
+ "storage, or secondary storage. "
+ "Of course more than one MemoryFacet related with HasPersistentMemory can be "
+ "attached to the same resource, but actually from an infrastructure management point of view, "
+ "we did not find any reason to further specialise the HasPersistentMemory relation.\n"
+ "we did not find any reason to further specialise the HasPersistentMemory relation. "
+ "Anyway, we do not exclude other specialisation required by services to select the "
+ "appropriated persistent memory better. "
+ "For example, to discriminate between Solid State Disk and Magnetic Rotative.",

2
src/main/java/org/gcube/resourcemanagement/model/reference/relations/consistsof/HasVolatileMemory.java
View File

@ -24,7 +24,7 @@ import org.gcube.resourcemanagement.model.reference.entities.facets.MemoryFacet;
@TypeMetadata(
name = HasVolatileMemory.NAME,
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. "
+ "Volatile memory is also known as main memory, internal memory or primary storage.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

4
src/main/java/org/gcube/resourcemanagement/model/reference/relations/consistsof/IsIdentifiedBy.java
View File

@ -30,8 +30,8 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.GCubeReso
@JsonDeserialize(as=IsIdentifiedByImpl.class)
@TypeMetadata(
name = IsIdentifiedBy.NAME,
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"
description = "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 {@link SoftwareFacet} but the one related with "
+ "IsIdentifiedBy represents the identify of the software.",
version = TypeVersion.MINIMAL_VERSION_STRING

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

@ -38,15 +38,15 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.VirtualMa
@TypeMetadata(
name = Activates.NAME,
description = "Activates has a {@link Service} instance both as source and target as "
+ "well as {@link CallsFor} but with a complete different semantic.\n"
+ "well as {@link CallsFor} but with a complete different semantic. "
+ "Activates is used to indicates that the source {@link Service} of the relation "
+ "enable the operation of the target Service. \n"
+ "enable the operation of the target Service. "
+ "Examples are between a {@link VirtualMachine} and an {@link HostingNode} to "
+ "capture the {@link VirtualMachine} is operating the {@link HostingNode}. \n"
+ "capture the {@link VirtualMachine} is operating the {@link HostingNode}. "
+ "Another example is between a {@link VirtualMachine} and an {@link EService}, "
+ "e.g., between a {@link VirtualMachine} and a database instance.\n"
+ "e.g., between a {@link VirtualMachine} and a database instance. "
+ "This relation can be created also between an {@link HostingNode} and one {@link EService}, "
+ "e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. \n"
+ "e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. "
+ "Activates is also used between an {@link EService} and a {@link RunningPlugin} which "
+ "enrich the functionality offered by the source service.",
version = TypeVersion.MINIMAL_VERSION_STRING

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

@ -24,7 +24,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Service;
@TypeMetadata(
name = CallsFor.NAME,
description = "A {@link Service} instance can require another {@link Service} instance to properly "
+ "operate and this is indicated with CallsFor.\n"
+ "operate and this is indicated with CallsFor. "
+ "Motivations similar to the ones for {@link Requires} relation conducted to the definition for this relation.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

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

@ -22,7 +22,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
@JsonDeserialize(as = DependsOnImpl.class)
@TypeMetadata(
name = DependsOn.NAME,
description = "DependsOn indicates that a {@link Software} requires another one to work.\n"
description = "DependsOn indicates that a {@link Software} requires another one to work. "
+ "This relation must not be confused with {@link Requires}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

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

@ -26,7 +26,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.EService;
@TypeMetadata(
name = Discovers.NAME,
description = "Any {@link EService} or its specialisations can be related with "
+ "another {@link EService} with Discovers relation.\n"
+ "another {@link EService} with Discovers relation. "
+ "Discovers relation inform that the source {@link EService} discovers "
+ "the target through the information system."
+ "Discovers relation specialise the semantic of {@link CallsFor}.",

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

@ -31,7 +31,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
@TypeMetadata(
name = Enables.NAME,
description = "Any {@link Service} representing running code of a specific software has the "
+ "relation Enables targeted to the corresponding {@link Software}.\n"
+ "relation Enables targeted to the corresponding {@link Software}. "
+ "Enables is used for example by {@link EService} to indicates the running software; "
+ "from {@link HostingNode} to indicate the running software container; "
+ "within {@link RunningPlugin} and the software represented as {@link Plugin}.",

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

@ -35,12 +35,12 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.VirtualMa
@JsonDeserialize(as=HostsImpl.class)
@TypeMetadata(
name = Hosts.NAME,
description = "Hosts relation is used from a {@link Site} a {@link Service} instance.\n"
+ "The target of the Hosts relation depends on the service offered by the Site.\n"
description = "Hosts relation is used from a {@link Site} a {@link Service} instance. "
+ "The target of the Hosts relation depends on the service offered by the Site. "
+ "When the resources provided by a site are virtual machines, "
+ "Hosts relation is created from a {@link Site} to a {@link VirtualMachine}.\n"
+ "When, instead a Site provides web-services, Hosts relation is created with {@link EService}.\n"
+ "If a site provides container facilities Hosts relation is created with {@link HostingNode}.\n"
+ "Hosts relation is created from a {@link Site} to a {@link VirtualMachine}. "
+ "When, instead a Site provides web-services, Hosts relation is created with {@link EService}. "
+ "If a site provides container facilities Hosts relation is created with {@link HostingNode}. "
+ "By defining Hosts relation with target {@link Service}, the model is capable of representing "
+ "the diverse type of federated systems and service.",
version = TypeVersion.MINIMAL_VERSION_STRING

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

@ -25,7 +25,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Site;
@JsonDeserialize(as=IsOwnedByImpl.class)
@TypeMetadata(
name = IsOwnedBy.NAME,
description = "Any {@link Site} is owned by an {@link Actor} and this is captured by the IsOwnedBy relation.\n"
description = "Any {@link Site} is owned by an {@link Actor} and this is captured by the IsOwnedBy relation. "
+ "The referenced {@link Actor} can be used as a contact point during an emergency, "
+ "to agree on the scheduling of a site downtime and to request additional resources "
+ "during the downtime of another site.",

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

@ -26,9 +26,9 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
@TypeMetadata(
name = IsPluginOf.NAME,
description = "A {@link Plugin} is a piece of Software extending the capabilities of another {@link Software} "
+ "(main) and requiring the main {@link Software} to be executed.\n"
+ "(main) and requiring the main {@link Software} to be executed. "
+ "The relation between the main {@link Software} and the {@link Plugin} "
+ "is expressed by IsPluginOf relation.\n"
+ "is expressed by IsPluginOf relation. "
+ "IsPluginOf is an extension of {@link DependsOn}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

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

@ -41,20 +41,20 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.Software;
@TypeMetadata(
name = Requires.NAME,
description = "Requires is used to indicate that the source {@link Software} when activated requires "
+ "to interact with a specific {@link Service} instance, i.e., the target of the relation.\n"
+ "This relation usually reflects an administrative constraint than a technological limitation.\n"
+ "to interact with a specific {@link Service} instance, i.e., the target of the relation. "
+ "This relation usually reflects an administrative constraint than a technological limitation. "
+ "When there are no constraint on the instance the relation is instead {@link DependsOn} "
+ "which is between two {@link Software}."
+ "Not necessarily all the {@link Software} running in the infrastructure are represented as resources. "
+ "Only the {@link Software} required for infrastructure administration or the ones to be managed "
+ "with specific policies are represented.\n"
+ "Indeed, Requires relation is normally used as policy constraint.\n"
+ "Let imagine an open source software which uses a MySQL database as backend.\n"
+ "In many cases, what characterises the software instance is the data present in the backend.\n"
+ "with specific policies are represented. "
+ "Indeed, Requires relation is normally used as policy constraint. "
+ "Let imagine an open source software which uses a MySQL database as backend. "
+ "In many cases, what characterises the software instance is the data present in the backend. "
+ "The infrastructure manager could stipulate an agreement with a provider having a particular "
+ "set of data which is not for public domain.\n"
+ "set of data which is not for public domain. "
+ "The software once deployed, giving the business agreement, is entitled to use the instance "
+ "of the provider and not a generic MySQL database instance.\n"
+ "of the provider and not a generic MySQL database instance. "
+ "The infrastructure manager imposes the use of such a particular instance because of the data it contains.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

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

@ -24,7 +24,7 @@ import org.gcube.resourcemanagement.model.reference.entities.resources.EService;
@TypeMetadata(
name = Uses.NAME,
description = "Uses relation inform regarding the network invocation of the target"
+ "{@link EService} by the source.\n"
+ "{@link EService} by the source. "
+ "Uses relation specialises the semantic of {@link CallsFor}.",
version = TypeVersion.MINIMAL_VERSION_STRING
)

6
src/test/java/org/gcube/resourcemanagement/model/reference/entities/facets/PolymorphismTest.java
View File

@ -46,10 +46,10 @@ public class PolymorphismTest {
public void testER() throws Exception {
Facet f = ElementMapper.unmarshal(Facet.class, MY_TEST_FACET);
logger.debug("\n\n{} {}\n\n", f.getClass().getSimpleName(), f);
logger.debug("{} {}", f.getClass().getSimpleName(), f);
ConsistsOf<?,?> c = ElementMapper.unmarshal(ConsistsOf.class, MY_CONSISTS_OF);
logger.debug("{} {}\n\n", c.getClass().getSimpleName(), c);
logger.debug("{} {}", c.getClass().getSimpleName(), c);
String[] eServices = new String[]{NYESERVICE, MYESERVICE, MYOTHERESERVICE, MYANOTHERESERVICE, NYESERVICE2, MYANOTHERESERVICE2};
//String[] eServices = new String[]{NYESERVICE2, MYANOTHERESERVICE2};
@ -65,8 +65,6 @@ public class PolymorphismTest {
Facet facet = consistsOf.getTarget();
logger.debug("{} {}", facet.getClass().getSimpleName(), facet);
}
logger.debug("\n\n");
}
}