Interface SubjectFacet

  • 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:
    SubjectFacetImpl

    @TypeMetadata(name="SubjectFacet",
                  description="SubjectFacet captures information on subjects associated with the resource for description, classification and discovery purposes.",
                  version="1.1.0")
    @Change(version="1.1.0",description="Replaced complex ValueSchema property for \'subject\' with a clean, flat String representation.") @Change(version="1.0.0",description="First Version")
    public interface SubjectFacet
    extends org.gcube.informationsystem.model.reference.entities.Facet
    SubjectFacet captures information on subjects associated with the resource for description, classification and discovery purposes.
    Author:
    Luca Frosini (ISTI - CNR)
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String NAME
      The name associated with this facet
      static String VERSION
      The version 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 SubjectFacet getDefaultInstance()
      Returns a default instance of SubjectFacet
      String getSubject()
      The value of the subject.
      void setSubject​(String subject)
      Sets the value of the subject.
      • 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 SubjectFacet getDefaultInstance()
        Returns a default instance of SubjectFacet
        Returns:
        a default instance of SubjectFacet
      • getSubject

        @ISProperty(description="The value of the subject.",
                    mandatory=true)
        String getSubject()
        The value of the subject. Deliberately unconstrained: accepts any JSON-compatible value (a plain keyword, a URI to a thesaurus term, or a richer structure) since the concrete classification scheme in use is not known in advance. The Java API always exposes it as a String.
        Returns:
        the subject
      • setSubject

        void setSubject​(String subject)
        Sets the value of the subject.
        Parameters:
        subject - the subject