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

Interface IdentifierFacet

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:
IdentifierFacetImpl
@TypeMetadata(name="IdentifierFacet", description="IdentifierFacet captures information on identifiers (other than the ones automatically generated by the system) that can be attached to a resource.", version="2.0.0") @Change(version="2.0.0",description="Removed the rigid IdentificationType enum in favor of an extensible free-text string field named \'scheme\' for REST compliance.") @Change(version="1.0.1",description="Added STRING in IdentificationType enum.") @Change(version="1.0.0",description="First Version") public interface IdentifierFacet extends org.gcube.informationsystem.model.reference.entities.Facet
IdentifierFacet captures information on identifiers (other than the ones automatically generated by the system) that can be attached to a resource.
Author:
Luca Frosini (ISTI - CNR)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    The name associated with this facet
    static final String
    SCHEME_PROPERTY
    The name of 'scheme' property
    static final String
    VALUE_PROPERTY
    The name of 'value' property
    static final 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

    Modifier and Type
    Method
    Description
    static IdentifierFacet
    getDefaultInstance()
    Returns a default instance of IdentifierFacet
    String
    getScheme()
    The identification scheme (e.g., "DOI", "ORCID", "SWHID", "UUID", "URI")
    String
    getValue()
    The identifier value
    boolean
    isPersistent()
    To indicate whether the identifier is persistent or not
    void
    setPersistent(boolean persistent)
    Sets whether the identifier is persistent or not
    void
    setScheme(String scheme)
    Sets the identification scheme
    void
    setValue(String value)
    Sets the identifier value

    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 IdentifierFacet getDefaultInstance()
      Returns a default instance of IdentifierFacet
      Returns:
      a default instance of IdentifierFacet

    • getValue

      @ISProperty(name="value", description="The identifier value.", mandatory=true) String getValue()
      The identifier value
      Returns:
      the value

    • setValue

      void setValue(String value)
      Sets the identifier value
      Parameters:
      value - the value

    • getScheme

      @ISProperty(name="scheme", description="The identification scheme (e.g., \'DOI\', \'ORCID\', \'SWHID\', \'UUID\', \'URI\').", mandatory=true) String getScheme()
      The identification scheme (e.g., "DOI", "ORCID", "SWHID", "UUID", "URI")
      Returns:
      the identification scheme

    • setScheme

      void setScheme(String scheme)
      Sets the identification scheme
      Parameters:
      scheme - the identification scheme

    • isPersistent

      @ISProperty(description="Whether the identifier is persistent or not.") boolean isPersistent()
      To indicate whether the identifier is persistent or not
      Returns:
      true if the identifier is persistent, false otherwise

    • setPersistent

      void setPersistent(boolean persistent)
      Sets whether the identifier is persistent or not
      Parameters:
      persistent - true if the identifier is persistent, false otherwise