Class NCModelAdapter

    • Constructor Detail

      • NCModelAdapter

        public NCModelAdapter​(String id,
                              String name,
                              String ver)
        Creates new model with the given mandatory parameters.
        Parameters:
        id - Model ID.
        name - Model name.
        ver - Model version.
    • Method Detail

      • getId

        public String getId()
        Description copied from interface: NCModelView
        Gets unique, immutable ID of this model.

        Note that model IDs are immutable while name and version can be changed freely. Changing model ID is equal to creating a completely new model. Model IDs (unlike name and version) are not exposed to the end user and only serve a technical purpose. ID's max length is 32 characters.

        JSON
        If using JSON/YAML model presentation this is set by id property:

         {
              "id": "my.model.id"
         }
         
        Specified by:
        getId in interface NCModelView
        Returns:
        Unique, immutable ID of this model.
      • getName

        public String getName()
        Description copied from interface: NCModelView
        Gets descriptive name of this model. Name's max length is 64 characters.

        JSON
        If using JSON/YAML model presentation this is set by name property:

         {
              "name": "My Model"
         }
         
        Specified by:
        getName in interface NCModelView
        Returns:
        Descriptive name for this model.
      • getVersion

        public String getVersion()
        Description copied from interface: NCModelView
        Gets the version of this model using semantic versioning. Version's max length is 16 characters.

        JSON
        If using JSON/YAML model presentation this is set by version property:

         {
              "version": "1.0.0"
         }
         
        Specified by:
        getVersion in interface NCModelView
        Returns:
        A version compatible with (www.semver.org) specification.