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

Interface SoftwareFacet

  • 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, Named, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable
    All Known Implementing Classes:
    SoftwareFacetImpl
    @TypeMetadata(name="SoftwareFacet",
              description="SoftwareFacet captures information on any software associated with the resource.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface SoftwareFacet
extends org.gcube.informationsystem.model.reference.entities.Facet, Named
    SoftwareFacet captures information on any software associated with the resource. https://wiki.gcube-system.org/gcube/GCube_Model#Software_Facet
    Author:
    Luca Frosini (ISTI - CNR)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String DESCRIPTION_PROPERTY  
      static String GROUP_PROPERTY  
      static String NAME  
      static String OPTIONAL_PROPERTY  
      static String QUALIFIER_PROPERTY  
      static String VERSION_PROPERTY  

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

        DATETIME_PATTERN, TYPE_PROPERTY

      • 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

      • Fields inherited from interface org.gcube.resourcemanagement.model.reference.properties.utilities.Named

        NAME_PROPERTY

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDescription()  
      String getGroup()  
      String getName()
      Gets the name of the facet.
      String getQualifier()  
      String getVersion()  
      boolean isOptional()  
      void setDescription​(String description)  
      void setGroup​(String group)  
      void setName​(String name)
      Sets the name of the facet.
      void setOptional​(boolean optional)  
      void setQualifier​(String qualifier)  
      void setVersion​(String version)  

      • 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

      • getName

        @ISProperty(name="name",
            description="The name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as \'Office\' (in Microsoft\u2122 Office 2013-SP2)",
            mandatory=true,
            nullable=false)
String getName()
        Description copied from interface: Named
        Gets the name of the facet.
        Specified by:
        getName in interface Named
        Returns:
        the name

      • setName

        void setName​(String name)
        Description copied from interface: Named
        Sets the name of the facet.
        Specified by:
        setName in interface Named
        Parameters:
        name - the new name

      • getGroup

        @ISProperty(name="group",
            description="The name of \'group\' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as \'Microsoft\u2122\' (in Microsoft\u2122 Office 2013-SP2)",
            mandatory=true,
            nullable=false)
String getGroup()

      • setGroup

        void setGroup​(String group)

      • getVersion

        @ISProperty(name="version",
            description="The particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as \'2013-SP2\' (in Microsoft\u2122 Office 2013-SP2)",
            mandatory=true,
            nullable=false)
String getVersion()

      • setVersion

        void setVersion​(String version)

      • getDescription

        @ISProperty(name="description",
            description="A human oriented description of the software artifact being described")
String getDescription()

      • setDescription

        void setDescription​(String description)

      • getQualifier

        @ISProperty(name="qualifier",
            description="A qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64")
String getQualifier()

      • setQualifier

        void setQualifier​(String qualifier)

      • isOptional

        @ISProperty(name="optional",
            description="Used to indicate the software optionality, e.g., optional in maven coordinates")
boolean isOptional()

      • setOptional

        void setOptional​(boolean optional)