Package org.ivoa.dm.regtap

Class InterfaceParam

java.lang.Object
org.ivoa.dm.regtap.InterfaceParam
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="RegTAP:InterfaceParam", role=objectType) public class InterfaceParam extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Input parameters for services. objectType: InterfaceParam

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • intf_index

      @VoDml(id="RegTAP:InterfaceParam.intf_index", role=attribute, type="ivoa:nonnegativeInteger", typeRole=primitiveType) protected Integer intf_index
      The index of the interface this parameter belongs to. : Attribute intf_index : multiplicity 1

    • name

      @VoDml(id="RegTAP:InterfaceParam.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      The name of the parameter. : Attribute name : multiplicity 1

    • unit

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

    • ucd

      @VoDml(id="RegTAP:InterfaceParam.ucd", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String ucd
      A unified content descriptor that describes the scientific content of the parameter. : Attribute ucd : multiplicity 0..1

    • utype

      @VoDml(id="RegTAP:InterfaceParam.utype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String utype
      An identifier for a role in a data model that the data in this parameter represents. : Attribute utype : multiplicity 0..1

    • std

      @VoDml(id="RegTAP:InterfaceParam.std", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer std
      If 1, the meaning and use of this parameter is reserved and defined by a standard model. If 0, it represents a database-specific parameter that effectively extends beyond the standard. : Attribute std : multiplicity 1

    • datatype

      @VoDml(id="RegTAP:InterfaceParam.datatype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String datatype
      The type of the data contained in the parameter. : Attribute datatype : multiplicity 0..1

    • extended_schema

      @VoDml(id="RegTAP:InterfaceParam.extended_schema", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String extended_schema
      An identifier for the schema that the value given by the extended attribute is drawn from. : Attribute extended_schema : multiplicity 0..1

    • extended_type

      @VoDml(id="RegTAP:InterfaceParam.extended_type", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String extended_type
      A custom type for the values this parameter contains. : Attribute extended_type : multiplicity 0..1

    • arraysize

      @VoDml(id="RegTAP:InterfaceParam.arraysize", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String arraysize
      The shape of the array that constitutes the value, e.g., 4, *, 4*, 5x4, or 5x*, as specified by VOTable. : Attribute arraysize : multiplicity 0..1

    • delim

      @VoDml(id="RegTAP:InterfaceParam.delim", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String delim
      The ivoa:string that is used to delimit elements of an array value when arraysize is not '1'. : Attribute delim : multiplicity 0..1

    • param_use

      @VoDml(id="RegTAP:InterfaceParam.param_use", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String param_use
      An indication of whether this parameter is required to be provided for the application or service to work properly (one of required, optional, ignored, or NULL). : Attribute param_use : multiplicity 0..1

    • param_description

      @VoDml(id="RegTAP:InterfaceParam.param_description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String param_description
      A free-text description of the parameter's contents. : Attribute param_description : multiplicity 0..1

  • Constructor Details

    • InterfaceParam

      public InterfaceParam()
      Creates a new InterfaceParam

    • InterfaceParam

      public InterfaceParam(Integer intf_index, String name, String unit, String ucd, String utype, Integer std, String datatype, String extended_schema, String extended_type, String arraysize, String delim, String param_use, String param_description)
      full parameter constructor.
      Parameters:
      intf_index - The index of the interface this parameter belongs to.
      name - The name of the parameter.
      unit - The unit associated with all values in the parameter.
      ucd - A unified content descriptor that describes the scientific content of the parameter.
      utype - An identifier for a role in a data model that the data in this parameter represents.
      std - If 1, the meaning and use of this parameter is reserved and defined by a standard model. If 0, it represents a database-specific parameter that effectively extends beyond the standard.
      datatype - The type of the data contained in the parameter.
      extended_schema - An identifier for the schema that the value given by the extended attribute is drawn from.
      extended_type - A custom type for the values this parameter contains.
      arraysize - The shape of the array that constitutes the value, e.g., 4, *, 4*, 5x4, or 5x*, as specified by VOTable.
      delim - The ivoa:string that is used to delimit elements of an array value when arraysize is not '1'.
      param_use - An indication of whether this parameter is required to be provided for the application or service to work properly (one of required, optional, ignored, or NULL).
      param_description - A free-text description of the parameter's contents.

    • InterfaceParam

      public InterfaceParam(InterfaceParam 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

    • updateUsing

      public void updateUsing(InterfaceParam 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.

    • getIntf_index

      public Integer getIntf_index()
      Returns intf_index Attribute.
      Returns:
      intf_index Attribute

    • setIntf_index

      public void setIntf_index(Integer pIntf_index)
      Set intf_index Attribute.
      Parameters:
      pIntf_index - value to set

    • withIntf_index

      public InterfaceParam withIntf_index(Integer pIntf_index)
      fluent setter for intf_index Attribute.
      Parameters:
      pIntf_index - value to set
      Returns:
      InterfaceParam

    • 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 InterfaceParam withName(String pName)
      fluent setter for name Attribute.
      Parameters:
      pName - value to set
      Returns:
      InterfaceParam

    • 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 InterfaceParam withUnit(String pUnit)
      fluent setter for unit Attribute.
      Parameters:
      pUnit - value to set
      Returns:
      InterfaceParam

    • 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 InterfaceParam withUcd(String pUcd)
      fluent setter for ucd Attribute.
      Parameters:
      pUcd - value to set
      Returns:
      InterfaceParam

    • 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 InterfaceParam withUtype(String pUtype)
      fluent setter for utype Attribute.
      Parameters:
      pUtype - value to set
      Returns:
      InterfaceParam

    • getStd

      public Integer getStd()
      Returns std Attribute.
      Returns:
      std Attribute

    • setStd

      public void setStd(Integer pStd)
      Set std Attribute.
      Parameters:
      pStd - value to set

    • withStd

      public InterfaceParam withStd(Integer pStd)
      fluent setter for std Attribute.
      Parameters:
      pStd - value to set
      Returns:
      InterfaceParam

    • getDatatype

      public String getDatatype()
      Returns datatype Attribute.
      Returns:
      datatype Attribute

    • setDatatype

      public void setDatatype(String pDatatype)
      Set datatype Attribute.
      Parameters:
      pDatatype - value to set

    • withDatatype

      public InterfaceParam withDatatype(String pDatatype)
      fluent setter for datatype Attribute.
      Parameters:
      pDatatype - value to set
      Returns:
      InterfaceParam

    • getExtended_schema

      public String getExtended_schema()
      Returns extended_schema Attribute.
      Returns:
      extended_schema Attribute

    • setExtended_schema

      public void setExtended_schema(String pExtended_schema)
      Set extended_schema Attribute.
      Parameters:
      pExtended_schema - value to set

    • withExtended_schema

      public InterfaceParam withExtended_schema(String pExtended_schema)
      fluent setter for extended_schema Attribute.
      Parameters:
      pExtended_schema - value to set
      Returns:
      InterfaceParam

    • getExtended_type

      public String getExtended_type()
      Returns extended_type Attribute.
      Returns:
      extended_type Attribute

    • setExtended_type

      public void setExtended_type(String pExtended_type)
      Set extended_type Attribute.
      Parameters:
      pExtended_type - value to set

    • withExtended_type

      public InterfaceParam withExtended_type(String pExtended_type)
      fluent setter for extended_type Attribute.
      Parameters:
      pExtended_type - value to set
      Returns:
      InterfaceParam

    • getArraysize

      public String getArraysize()
      Returns arraysize Attribute.
      Returns:
      arraysize Attribute

    • setArraysize

      public void setArraysize(String pArraysize)
      Set arraysize Attribute.
      Parameters:
      pArraysize - value to set

    • withArraysize

      public InterfaceParam withArraysize(String pArraysize)
      fluent setter for arraysize Attribute.
      Parameters:
      pArraysize - value to set
      Returns:
      InterfaceParam

    • getDelim

      public String getDelim()
      Returns delim Attribute.
      Returns:
      delim Attribute

    • setDelim

      public void setDelim(String pDelim)
      Set delim Attribute.
      Parameters:
      pDelim - value to set

    • withDelim

      public InterfaceParam withDelim(String pDelim)
      fluent setter for delim Attribute.
      Parameters:
      pDelim - value to set
      Returns:
      InterfaceParam

    • getParam_use

      public String getParam_use()
      Returns param_use Attribute.
      Returns:
      param_use Attribute

    • setParam_use

      public void setParam_use(String pParam_use)
      Set param_use Attribute.
      Parameters:
      pParam_use - value to set

    • withParam_use

      public InterfaceParam withParam_use(String pParam_use)
      fluent setter for param_use Attribute.
      Parameters:
      pParam_use - value to set
      Returns:
      InterfaceParam

    • getParam_description

      public String getParam_description()
      Returns param_description Attribute.
      Returns:
      param_description Attribute

    • setParam_description

      public void setParam_description(String pParam_description)
      Set param_description Attribute.
      Parameters:
      pParam_description - value to set

    • withParam_description

      public InterfaceParam withParam_description(String pParam_description)
      fluent setter for param_description Attribute.
      Parameters:
      pParam_description - value to set
      Returns:
      InterfaceParam

    • createInterfaceParam

      public static InterfaceParam createInterfaceParam(Consumer<InterfaceParam.InterfaceParamBuilder> f)
      create a InterfaceParam 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>