Package org.ivoa.dm.registry.vodataservice

Class BaseParam

java.lang.Object
org.ivoa.dm.registry.vodataservice.BaseParam
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Direct Known Subclasses:
InputParam, TableParam
@Entity @VoDml(id="VODataService:BaseParam", role=objectType) public class BaseParam extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A description of a parameter that places no restriction on the parameter's data type. As the parameter's data type is usually important, schemas normally employ a sub-class of this type rather than this type directly. objectType: BaseParam

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="VODataService:BaseParam.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      The name of the parameter or column. : Attribute name : multiplicity 0..1

    • description

      @VoDml(id="VODataService:BaseParam.description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String description
      A free-text description of a parameter's or column's contents. : Attribute description : multiplicity 0..1

    • unit

      @VoDml(id="VODataService:BaseParam.unit", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String unit
      The unit associated with the values in the parameter or column. : Attribute unit : multiplicity 0..1

    • ucd

      @VoDml(id="VODataService:BaseParam.ucd", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String ucd
      The name of a unified content descriptor that describes the scientific content of the parameter. There are no requirements for compliance with any particular UCD standard. : Attribute ucd : multiplicity 0..1

    • utype

      @VoDml(id="VODataService:BaseParam.utype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String utype
      An identifier for a concept in a data model that the data in this schema represent. The form of the utype string depends on the data model; common forms are sequences of dotted identifiers (e.g., in SSA) or URIs (e.g., in RegTAP). : Attribute utype : multiplicity 0..1

  • Constructor Details

    • BaseParam

      public BaseParam()
      Creates a new BaseParam

    • BaseParam

      public BaseParam(String name, String description, String unit, String ucd, String utype)
      full parameter constructor.
      Parameters:
      name - The name of the parameter or column.
      description - A free-text description of a parameter's or column's contents.
      unit - The unit associated with the values in the parameter or column.
      ucd - The name of a unified content descriptor that describes the scientific content of the parameter. There are no requirements for compliance with any particular UCD standard.
      utype - An identifier for a concept in a data model that the data in this schema represent. The form of the utype string depends on the data model; common forms are sequences of dotted identifiers (e.g., in SSA) or URIs (e.g., in RegTAP).

    • BaseParam

      public BaseParam(BaseParam other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • copyMe

      public BaseParam copyMe()
      make a clone of the object taking into account current polymorhic type.
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(BaseParam other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getName

      public String getName()
      Returns name Attribute.
      Returns:
      name Attribute

    • setName

      public void setName(String pName)
      Set name Attribute.
      Parameters:
      pName - value to set

    • withName

      public BaseParam withName(String pName)
      fluent setter for name Attribute.
      Parameters:
      pName - value to set
      Returns:
      BaseParam

    • getDescription

      public String getDescription()
      Returns description Attribute.
      Returns:
      description Attribute

    • setDescription

      public void setDescription(String pDescription)
      Set description Attribute.
      Parameters:
      pDescription - value to set

    • withDescription

      public BaseParam withDescription(String pDescription)
      fluent setter for description Attribute.
      Parameters:
      pDescription - value to set
      Returns:
      BaseParam

    • getUnit

      public String getUnit()
      Returns unit Attribute.
      Returns:
      unit Attribute

    • setUnit

      public void setUnit(String pUnit)
      Set unit Attribute.
      Parameters:
      pUnit - value to set

    • withUnit

      public BaseParam withUnit(String pUnit)
      fluent setter for unit Attribute.
      Parameters:
      pUnit - value to set
      Returns:
      BaseParam

    • getUcd

      public String getUcd()
      Returns ucd Attribute.
      Returns:
      ucd Attribute

    • setUcd

      public void setUcd(String pUcd)
      Set ucd Attribute.
      Parameters:
      pUcd - value to set

    • withUcd

      public BaseParam withUcd(String pUcd)
      fluent setter for ucd Attribute.
      Parameters:
      pUcd - value to set
      Returns:
      BaseParam

    • getUtype

      public String getUtype()
      Returns utype Attribute.
      Returns:
      utype Attribute

    • setUtype

      public void setUtype(String pUtype)
      Set utype Attribute.
      Parameters:
      pUtype - value to set

    • withUtype

      public BaseParam withUtype(String pUtype)
      fluent setter for utype Attribute.
      Parameters:
      pUtype - value to set
      Returns:
      BaseParam

    • createBaseParam

      public static BaseParam createBaseParam(Consumer<BaseParam.BaseParamBuilder> f)
      create a BaseParam in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>