Package org.gcube.resourcemanagement.model.reference.entities.facets

Interface MemoryFacet

  • All Superinterfaces:
    org.gcube.informationsystem.base.reference.Element, org.gcube.informationsystem.model.reference.entities.Entity, org.gcube.informationsystem.base.reference.entities.EntityElement, org.gcube.informationsystem.model.reference.ERElement, org.gcube.informationsystem.model.reference.entities.Facet, org.gcube.informationsystem.base.reference.IdentifiableElement, org.gcube.informationsystem.model.reference.ModelElement, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable
    All Known Implementing Classes:
    MemoryFacetImpl
    @TypeMetadata(name="MemoryFacet",
              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, the ConsistsOf relation called [HasMemory](type:HasMemory) has been identified. It is in charge of the specialisation [HasVolatileMemory](type:HasVolatileMemory) and [HasPersistentMemory](type:HasPersistentMemory) to clarify the semantics of the memory.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface MemoryFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
    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, the ConsistsOf relation called HasMemory has been identified. It is specialised by HasVolatileMemory and HasPersistentMemory to clarify the semantics of the memory.
    Author:
    Luca Frosini (ISTI - CNR)

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  MemoryFacet.MemoryUnit
      Enumeration of possible memory units

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String NAME
      The name associated with this facet

      • Fields inherited from interface org.gcube.informationsystem.base.reference.Element

        DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ERElement

        CONTEXTS_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

        ID_PROPERTY, METADATA_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

        EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static MemoryFacet getDefaultInstance()
      Returns a default instance of MemoryFacet
      long getSize()
      The size of the memory
      MemoryFacet.MemoryUnit getUnit()
      The memory unit
      long getUsed()
      The used memory
      void setSize​(long size)
      Sets the size of the memory
      void setUnit​(MemoryFacet.MemoryUnit unit)
      Sets the memory unit
      void setUsed​(long used)
      Sets the used memory

      • Methods inherited from interface org.gcube.informationsystem.base.reference.Element

        getTypeName

      • Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

        getID, getMetadata, setID, setMetadata

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ERElement

        getContexts

      • Methods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet

        getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement

        getExpectedType, getSupertypes

    • Method Detail

      • getDefaultInstance

        static MemoryFacet getDefaultInstance()
        Returns a default instance of MemoryFacet
        Returns:
        a default instance of MemoryFacet

      • getSize

        @ISProperty(description="The size of the memory.")
long getSize()
        The size of the memory
        Returns:
        the size

      • setSize

        void setSize​(long size)
        Sets the size of the memory
        Parameters:
        size - the size

      • getUsed

        @ISProperty(description="The amount of memory currently in use.")
long getUsed()
        The used memory
        Returns:
        the used

      • setUsed

        void setUsed​(long used)
        Sets the used memory
        Parameters:
        used - the used

      • getUnit

        @ISProperty(description="The unit of measurement for the memory size and used amount, e.g., MB, GB, TB.")
MemoryFacet.MemoryUnit getUnit()
        The memory unit
        Returns:
        the unit