Package org.ivoa.dm.registry.vodataservice

Class InputParam.InputParamBuilder

java.lang.Object
org.ivoa.dm.registry.vodataservice.InputParam.InputParamBuilder
Enclosing class:
InputParam
public static class InputParam.InputParamBuilder extends Object
A builder class for InputParam, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    DataType
    dataType
    A type of data contained in the parameter.
    String
    description
    A free-text description of a parameter's or column's contents.
    String
    name
    The name of the parameter or column.
    Boolean
    std
    If true, the meaning and behavior of this parameter is reserved and defined by a standard interface.
    String
    ucd
    The name of a unified content descriptor that describes the scientific content of the parameter.
    String
    unit
    The unit associated with the values in the parameter or column.
    ParamUse
    use
    An indication of whether this parameter is required to be provided for the application or service to work properly.
    String
    utype
    An identifier for a concept in a data model that the data in this schema represent.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InputParamBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    InputParam
    create()
    create a InputParam from this builder.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • dataType

      public DataType dataType
      A type of data contained in the parameter.

    • use

      public ParamUse use
      An indication of whether this parameter is required to be provided for the application or service to work properly.

    • std

      public Boolean std
      If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.

    • name

      public String name
      The name of the parameter or column.

    • description

      public String description
      A free-text description of a parameter's or column's contents.

    • unit

      public String unit
      The unit associated with the values in the parameter or column.

    • ucd

      public 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.

    • utype

      public 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).

  • Constructor Details

    • InputParamBuilder

      public InputParamBuilder()

  • Method Details

    • create

      public InputParam create()
      create a InputParam from this builder.
      Returns:
      an object initialized from the builder.