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

Interface TemplateFacet

  • 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:
    TemplateFacetImpl
    @TypeMetadata(name="TemplateFacet",
              description="This facet define a template for a Facet to instantiate using the list of attributes specified. The type of the instatianted facet is specified in \'targetFacetType\' attribute",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface TemplateFacet
extends org.gcube.informationsystem.model.reference.entities.Facet, Named
    Author:
    Luca Frosini (ISTI - CNR)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String DESCRIPTION_PROPERTY
      The name of 'description' property
      static String NAME
      The name associated with this facet
      static String PROPERTIES_PROPERTY
      The name of 'properties' property
      static String TARGET_TYPE_PROPERTY
      The name of 'targetType' 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 Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addProperty​(AttributeProperty property)
      Adds an attribute to the template to be created when instantiated
      static TemplateFacet getDefaultInstance()
      Returns a default instance of TemplateFacet
      String getDescription()
      The description of the template
      String getName()
      The name of the template
      List<AttributeProperty> getProperties()
      The attributes of the template to be created when instantiated
      String getTargetType()
      The type of Facet to instantiate with the attributes valued
      void setDescription​(String description)
      Sets the description of the template
      void setName​(String name)
      Sets the name of the template
      void setProperties​(List<AttributeProperty> properties)
      Sets the attributes of the template to be created when instantiated
      void setTargetType​(String targetType)
      Sets the type of Facet to instantiate with the attributes valued

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

      • getName

        @ISProperty(name="name",
            description="The name of the template",
            mandatory=true,
            nullable=false)
String getName()
        The name of the template
        Specified by:
        getName in interface Named
        Returns:
        the name

      • setName

        void setName​(String name)
        Sets the name of the template
        Specified by:
        setName in interface Named
        Parameters:
        name - the name

      • getDescription

        @ISProperty(name="description",
            description="The description of the template",
            readonly=false,
            mandatory=true,
            nullable=false)
String getDescription()
        The description of the template
        Returns:
        the description

      • setDescription

        void setDescription​(String description)
        Sets the description of the template
        Parameters:
        description - the description

      • getTargetType

        @ISProperty(name="targetType",
            description="The type of Facet to instantiate with the attributes valued",
            readonly=false,
            mandatory=true,
            nullable=false)
String getTargetType()
        The type of Facet to instantiate with the attributes valued
        Returns:
        the targetType

      • setTargetType

        void setTargetType​(String targetType)
        Sets the type of Facet to instantiate with the attributes valued
        Parameters:
        targetType - the targetType

      • getProperties

        @ISProperty(name="properties",
            description="The attributes of the template to be created when instantiated",
            readonly=false,
            mandatory=true,
            nullable=false,
            min=1)
List<AttributeProperty> getProperties()
        The attributes of the template to be created when instantiated
        Returns:
        the properties

      • setProperties

        void setProperties​(List<AttributeProperty> properties)
        Sets the attributes of the template to be created when instantiated
        Parameters:
        properties - the properties

      • addProperty

        void addProperty​(AttributeProperty property)
        Adds an attribute to the template to be created when instantiated
        Parameters:
        property - the property