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

Interface ClassificationFacet

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:
ClassificationFacetImpl
@TypeMetadata(name="ClassificationFacet", description="ClassificationFacet captures classification scheme, taxonomy category and logical name to classify any resource inside the infrastructure.", version="1.0.0") @Change(version="1.0.0", description="First version introducing taxonomy classification scheme, category and name fields.") public interface ClassificationFacet extends org.gcube.informationsystem.model.reference.entities.Facet
ClassificationFacet captures classification scheme, taxonomy category and logical name to classify any resource inside the infrastructure.
Author:
Luca Frosini (ISTI - CNR)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final 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

    Modifier and Type
    Method
    Description
    String
    getCategory()
    The category of the classification (e.g., "Database", "SearchEngine")
    String
    getClassification()
    The classification scheme or context of this taxonomy (e.g., "Infrastructure Management")
    static ClassificationFacet
    getDefaultInstance()
    Returns a default instance of ClassificationFacet
    String
    getName()
    The logical/functional name associated with this classification context (e.g., "Ckan-DB")
    void
    setCategory(String category)
    Sets the category of the classification
    void
    setClassification(String classification)
    Sets the classification scheme or context
    void
    setName(String name)
    Sets the logical/functional name

    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

  • Field Details

  • Method Details

    • getDefaultInstance

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

    • getClassification

      @ISProperty(description="The classification scheme or context of this taxonomy (e.g., \'Infrastructure Management\').", mandatory=true) String getClassification()
      The classification scheme or context of this taxonomy (e.g., "Infrastructure Management")
      Returns:
      the classification

    • setClassification

      void setClassification(String classification)
      Sets the classification scheme or context
      Parameters:
      classification - the classification

    • getCategory

      @ISProperty(description="The category of the classification (e.g., \'Database\', \'SearchEngine\').", mandatory=true) String getCategory()
      The category of the classification (e.g., "Database", "SearchEngine")
      Returns:
      the category

    • setCategory

      void setCategory(String category)
      Sets the category of the classification
      Parameters:
      category - the category

    • getName

      @ISProperty(description="The logical/functional name associated with this classification context (e.g., \'Ckan-DB\').", mandatory=true) String getName()
      The logical/functional name associated with this classification context (e.g., "Ckan-DB")
      Returns:
      the name

    • setName

      void setName(String name)
      Sets the logical/functional name
      Parameters:
      name - the name