Package org.ivoa.dm.tapschema

Class Column

java.lang.Object
org.ivoa.dm.tapschema.Column
All Implemented Interfaces:
org.ivoa.vodml.jaxb.XmlIdManagement, org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<String>
@Entity @VoDml(id="tapschema:column", role=objectType) public class Column extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<String>, org.ivoa.vodml.jaxb.XmlIdManagement
the column.

objectType: Column

  • Field Details

    • table_name

      protected String table_name
      additional key to parent of composition.

    • column_name

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

    • datatype

      @VoDml(id="tapschema:column.datatype", role=attribute, type="tapschema:TAPType", typeRole=enumeration) protected TAPType datatype
      the type of the column (VOTable semantics). : Attribute datatype : multiplicity 1

    • arraysize

      @VoDml(id="tapschema:column.arraysize", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String arraysize
      . : Attribute arraysize : multiplicity 0..1

    • xtype

      @VoDml(id="tapschema:column.xtype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String xtype
      . : Attribute xtype : multiplicity 0..1

    • description

      @VoDml(id="tapschema:column.description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String description
      . : Attribute description : multiplicity 0..1

    • utype

      @VoDml(id="tapschema:column.utype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String utype
      . : Attribute utype : multiplicity 0..1

    • unit

      @VoDml(id="tapschema:column.unit", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String unit
      . : Attribute unit : multiplicity 0..1

    • ucd

      @VoDml(id="tapschema:column.ucd", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String ucd
      . : Attribute ucd : multiplicity 0..1

    • indexed

      @VoDml(id="tapschema:column.indexed", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean indexed
      does the column have an index. : Attribute indexed : multiplicity 1

    • principal

      @VoDml(id="tapschema:column.principal", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean principal
      indicates that the column is considered a core part of the content; clients can use this hint to make the principal column(s) visible, for example by selecting them by default in generating an ADQL query. In cases where the service selects the columns to return (such as a query language without an explicit output selection), the principal column indicates those columns that are returned by default. : Attribute principal : multiplicity 1

    • std

      @VoDml(id="tapschema:column.std", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean std
      is the column defined by a standard. : Attribute std : multiplicity 1

    • column_index

      @VoDml(id="tapschema:column.column_index", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer column_index
      used to recommend table ordering for clients. Clients may order by index (ascending) so lower index items would appear earlier in a listing. : Attribute column_index : multiplicity 0..1

  • Constructor Details

    • Column

      public Column()
      Creates a new column

    • Column

      public Column(String column_name, TAPType datatype, String arraysize, String xtype, String description, String utype, String unit, String ucd, Boolean indexed, Boolean principal, Boolean std, Integer column_index)
      full parameter constructor.
      Parameters:
      column_name - name of the column.
      datatype - the type of the column (VOTable semantics).
      arraysize - .
      xtype - .
      description - .
      utype - .
      unit - .
      ucd - .
      indexed - does the column have an index.
      principal - indicates that the column is considered a core part of the content; clients can use this hint to make the principal column(s) visible, for example by selecting them by default in generating an ADQL query. In cases where the service selects the columns to return (such as a query language without an explicit output selection), the principal column indicates those columns that are returned by default.
      std - is the column defined by a standard.
      column_index - used to recommend table ordering for clients. Clients may order by index (ascending) so lower index items would appear earlier in a listing.

    • 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

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

    • getColumn_name

      public String getColumn_name()
      Returns column_name Attribute.
      Returns:
      column_name Attribute

    • setColumn_name

      public void setColumn_name(String pColumn_name)
      Set column_name Attribute.
      Parameters:
      pColumn_name - value to set

    • withColumn_name

      public Column withColumn_name(String pColumn_name)
      fluent setter for column_name Attribute.
      Parameters:
      pColumn_name - value to set
      Returns:
      column

    • getDatatype

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

    • setDatatype

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

    • withDatatype

      public Column withDatatype(TAPType pDatatype)
      fluent setter for datatype Attribute.
      Parameters:
      pDatatype - 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

    • getXtype

      public String getXtype()
      Returns xtype Attribute.
      Returns:
      xtype Attribute

    • setXtype

      public void setXtype(String pXtype)
      Set xtype Attribute.
      Parameters:
      pXtype - value to set

    • withXtype

      public Column withXtype(String pXtype)
      fluent setter for xtype Attribute.
      Parameters:
      pXtype - value to set
      Returns:
      column

    • 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 Column withDescription(String pDescription)
      fluent setter for description Attribute.
      Parameters:
      pDescription - 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

    • 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

    • 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

    • getIndexed

      public Boolean getIndexed()
      Returns indexed Attribute.
      Returns:
      indexed Attribute

    • setIndexed

      public void setIndexed(Boolean pIndexed)
      Set indexed Attribute.
      Parameters:
      pIndexed - value to set

    • withIndexed

      public Column withIndexed(Boolean pIndexed)
      fluent setter for indexed Attribute.
      Parameters:
      pIndexed - value to set
      Returns:
      column

    • getPrincipal

      public Boolean getPrincipal()
      Returns principal Attribute.
      Returns:
      principal Attribute

    • setPrincipal

      public void setPrincipal(Boolean pPrincipal)
      Set principal Attribute.
      Parameters:
      pPrincipal - value to set

    • withPrincipal

      public Column withPrincipal(Boolean pPrincipal)
      fluent setter for principal Attribute.
      Parameters:
      pPrincipal - value to set
      Returns:
      column

    • getStd

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

    • setStd

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

    • withStd

      public Column withStd(Boolean pStd)
      fluent setter for std Attribute.
      Parameters:
      pStd - value to set
      Returns:
      column

    • getColumn_index

      public Integer getColumn_index()
      Returns column_index Attribute.
      Returns:
      column_index Attribute

    • setColumn_index

      public void setColumn_index(Integer pColumn_index)
      Set column_index Attribute.
      Parameters:
      pColumn_index - value to set

    • withColumn_index

      public Column withColumn_index(Integer pColumn_index)
      fluent setter for column_index Attribute.
      Parameters:
      pColumn_index - value to set
      Returns:
      column

    • getXmlId

      public String getXmlId()
      Specified by:
      getXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • setXmlId

      public void setXmlId(String id)
      Specified by:
      setXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • hasNaturalKey

      public boolean hasNaturalKey()
      Specified by:
      hasNaturalKey in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • getId

      public String getId()
      return the database key id. Note that this is the same as attribute column_name.
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<String>
      Returns:
      the id

    • 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<String>