Package org.ivoa.dm.regtap

Class Column

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

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • table_index

      @VoDml(id="RegTAP:Column.table_index", role=attribute, type="ivoa:nonnegativeInteger", typeRole=primitiveType) protected Integer table_index
      Index of the table this column belongs to. : Attribute table_index : multiplicity 1

    • name

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

    • ucd

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

    • unit

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

    • utype

      @VoDml(id="RegTAP:Column.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 column represents. : Attribute utype : multiplicity 0..1

    • std

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

    • datatype

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

    • extended_schema

      @VoDml(id="RegTAP:Column.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:Column.extended_type", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String extended_type
      A custom type for the values this column contains. : Attribute extended_type : multiplicity 0..1

    • arraysize

      @VoDml(id="RegTAP:Column.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:Column.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

    • type_system

      @VoDml(id="RegTAP:Column.type_system", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String type_system
      The type system used, as a QName with a canonical prefix; this will ususally be one of vs:simpledatatype, vs:votabletype, and vs:taptype. : Attribute type_system : multiplicity 0..1

    • flag

      @VoDml(id="RegTAP:Column.flag", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String flag
      Hash-separated keywords representing traits of the column. Recognized values include 'indexed', 'primary', and 'nullable'. : Attribute flag : multiplicity 0..1

    • column_description

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

  • Constructor Details

    • Column

      public Column()
      Creates a new Column

    • Column

      public Column(Integer table_index, String name, String ucd, String unit, String utype, Integer std, String datatype, String extended_schema, String extended_type, String arraysize, String delim, String type_system, String flag, String column_description)
      full parameter constructor.
      Parameters:
      table_index - Index of the table this column belongs to.
      name - The name of the column.
      ucd - A unified content descriptor that describes the scientific content of the column.
      unit - The unit associated with all values in the column.
      utype - An identifier for a role in a data model that the data in this column represents.
      std - If 1, the meaning and use of this column is reserved and defined by a standard model. If 0, it represents a database-specific column that effectively extends beyond the standard.
      datatype - The type of the data contained in the column.
      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 column 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'.
      type_system - The type system used, as a QName with a canonical prefix; this will ususally be one of vs:simpledatatype, vs:votabletype, and vs:taptype.
      flag - Hash-separated keywords representing traits of the column. Recognized values include 'indexed', 'primary', and 'nullable'.
      column_description - A free-text description of the column's contents.

    • Column

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

    • getTable_index

      public Integer getTable_index()
      Returns table_index Attribute.
      Returns:
      table_index Attribute

    • setTable_index

      public void setTable_index(Integer pTable_index)
      Set table_index Attribute.
      Parameters:
      pTable_index - value to set

    • withTable_index

      public Column withTable_index(Integer pTable_index)
      fluent setter for table_index Attribute.
      Parameters:
      pTable_index - value to set
      Returns:
      Column

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

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

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

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

    • 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 Column withStd(Integer pStd)
      fluent setter for std Attribute.
      Parameters:
      pStd - value to set
      Returns:
      Column

    • 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 Column withDatatype(String pDatatype)
      fluent setter for datatype Attribute.
      Parameters:
      pDatatype - value to set
      Returns:
      Column

    • 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 Column withExtended_schema(String pExtended_schema)
      fluent setter for extended_schema Attribute.
      Parameters:
      pExtended_schema - value to set
      Returns:
      Column

    • 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 Column withExtended_type(String pExtended_type)
      fluent setter for extended_type Attribute.
      Parameters:
      pExtended_type - value to set
      Returns:
      Column

    • 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 Column withArraysize(String pArraysize)
      fluent setter for arraysize Attribute.
      Parameters:
      pArraysize - value to set
      Returns:
      Column

    • 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 Column withDelim(String pDelim)
      fluent setter for delim Attribute.
      Parameters:
      pDelim - value to set
      Returns:
      Column

    • getType_system

      public String getType_system()
      Returns type_system Attribute.
      Returns:
      type_system Attribute

    • setType_system

      public void setType_system(String pType_system)
      Set type_system Attribute.
      Parameters:
      pType_system - value to set

    • withType_system

      public Column withType_system(String pType_system)
      fluent setter for type_system Attribute.
      Parameters:
      pType_system - value to set
      Returns:
      Column

    • getFlag

      public String getFlag()
      Returns flag Attribute.
      Returns:
      flag Attribute

    • setFlag

      public void setFlag(String pFlag)
      Set flag Attribute.
      Parameters:
      pFlag - value to set

    • withFlag

      public Column withFlag(String pFlag)
      fluent setter for flag Attribute.
      Parameters:
      pFlag - value to set
      Returns:
      Column

    • getColumn_description

      public String getColumn_description()
      Returns column_description Attribute.
      Returns:
      column_description Attribute

    • setColumn_description

      public void setColumn_description(String pColumn_description)
      Set column_description Attribute.
      Parameters:
      pColumn_description - value to set

    • withColumn_description

      public Column withColumn_description(String pColumn_description)
      fluent setter for column_description Attribute.
      Parameters:
      pColumn_description - value to set
      Returns:
      Column

    • createColumn

      public static Column createColumn(Consumer<Column.ColumnBuilder> f)
      create a Column 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>