Package org.ivoa.dm.registry.vodataservice

Class TableParam

java.lang.Object

org.ivoa.dm.registry.vodataservice.BaseParam

org.ivoa.dm.registry.vodataservice.TableParam

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

@Entity
@VoDml(id="VODataService:TableParam",
       role=objectType)
public class TableParam
extends BaseParam
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

A description of a table parameter having a fixed data type. objectType: TableParam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableParam.TableParamBuilder	A builder class for TableParam, mainly for use in the functional builder pattern.

Nested classes/interfaces inherited from class org.ivoa.dm.registry.vodataservice.BaseParam

BaseParam.BaseParamBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected TableDataType	dataType	A type of data contained in the column .
protected List<String>	flag	A keyword representing traits of the column.
protected Boolean	std	If true, the meaning and use of this parameter is reserved and defined by a standard model.

Fields inherited from class org.ivoa.dm.registry.vodataservice.BaseParam

_id, description, name, ucd, unit, utype

Constructor Summary

Constructors

Constructor	Description
TableParam()	Creates a new TableParam
TableParam(BaseParam superinstance, TableDataType dataType, List<String> flag, Boolean std)	Constructor from supertype instance.
TableParam(TableDataType dataType, List<String> flag, Boolean std, String name, String description, String unit, String ucd, String utype)	full parameter constructor.
TableParam(TableParam other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
BaseParam	copyMe()	make a clone of the object taking into account current polymorhic type.
static TableParam	createTableParam(Consumer<TableParam.TableParamBuilder> f)	create a TableParam in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
TableDataType	getDataType()	Returns dataType Attribute.
List<String>	getFlag()	Returns flag Attribute.
Boolean	getStd()	Returns std Attribute.
void	setDataType(TableDataType pDataType)	Set dataType Attribute.
void	setFlag(List<String> pFlag)	Set flag Attribute.
void	setStd(Boolean pStd)	Set std Attribute.
void	updateUsing(TableParam other)	Update this object with the content of the given object.
TableParam	withDataType(TableDataType pDataType)	fluent setter for dataType Attribute.
TableParam	withFlag(List<String> pFlag)	fluent setter for flag Attribute.
TableParam	withStd(Boolean pStd)	fluent setter for std Attribute.

Methods inherited from class org.ivoa.dm.registry.vodataservice.BaseParam

createBaseParam, getDescription, getId, getName, getUcd, getUnit, getUtype, setDescription, setName, setUcd, setUnit, setUtype, updateUsing, withDescription, withName, withUcd, withUnit, withUtype

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

getId

Field Details

dataType

@VoDml(id="VODataService:TableParam.dataType",
       role=attribute,
       type="VODataService:TableDataType",
       typeRole=dataType)
protected TableDataType dataType

A type of data contained in the column . : Attribute dataType : multiplicity 0..1

flag

@VoDml(id="VODataService:TableParam.flag",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected List<String> flag

A keyword representing traits of the column. Recognized values include “indexed”, “primary”, and “nullable”. While other values are allowed, the following semantics is defined by this specification: indexed – The column has an index on it for faster search against its values; primary – The values column in the column represent in total or in part a primary key for its table; nullable – the column may contain null or empty values. : Attribute flag : multiplicity 0..*

std

@VoDml(id="VODataService:TableParam.std",
       role=attribute,
       type="ivoa:boolean",
       typeRole=primitiveType)
protected Boolean std

If true, the meaning and use of this parameter is reserved and defined by a standard model. If false, it represents a parameter specific to the data described If not provided, then the value is unknown. : Attribute std : multiplicity 1

Constructor Details

TableParam

public TableParam()

Creates a new TableParam

TableParam

public TableParam(TableDataType dataType,
 List<String> flag,
 Boolean std,
 String name,
 String description,
 String unit,
 String ucd,
 String utype)

full parameter constructor.

Parameters:

dataType - A type of data contained in the column .

flag - A keyword representing traits of the column. Recognized values include “indexed”, “primary”, and “nullable”. While other values are allowed, the following semantics is defined by this specification: indexed – The column has an index on it for faster search against its values; primary – The values column in the column represent in total or in part a primary key for its table; nullable – the column may contain null or empty values.

std - If true, the meaning and use of this parameter is reserved and defined by a standard model. If false, it represents a parameter specific to the data described If not provided, then the value is unknown.

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

TableParam

public TableParam(TableParam other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

TableParam

public TableParam(BaseParam superinstance,
 TableDataType dataType,
 List<String> flag,
 Boolean std)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

dataType - A type of data contained in the column .

flag - A keyword representing traits of the column. Recognized values include “indexed”, “primary”, and “nullable”. While other values are allowed, the following semantics is defined by this specification: indexed – The column has an index on it for faster search against its values; primary – The values column in the column represent in total or in part a primary key for its table; nullable – the column may contain null or empty values.

std - If true, the meaning and use of this parameter is reserved and defined by a standard model. If false, it represents a parameter specific to the data described If not provided, then the value is unknown.

Method Details

copyMe

public BaseParam copyMe()

make a clone of the object taking into account current polymorhic type.

Overrides:

copyMe in class BaseParam

Returns:

the cloned object.

updateUsing

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

getDataType

public TableDataType getDataType()

Returns dataType Attribute.

Returns:

dataType Attribute

setDataType

public void setDataType(TableDataType pDataType)

Set dataType Attribute.

Parameters:

pDataType - value to set

withDataType

public TableParam withDataType(TableDataType pDataType)

fluent setter for dataType Attribute.

Parameters:

pDataType - value to set

Returns:

TableParam

getFlag

public List<String> getFlag()

Returns flag Attribute.

Returns:

flag Attribute

setFlag

public void setFlag(List<String> pFlag)

Set flag Attribute.

Parameters:

pFlag - value to set

withFlag

public TableParam withFlag(List<String> pFlag)

fluent setter for flag Attribute.

Parameters:

pFlag - value to set

Returns:

TableParam

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 TableParam withStd(Boolean pStd)

fluent setter for std Attribute.

Parameters:

pStd - value to set

Returns:

TableParam

createTableParam

public static TableParam createTableParam(Consumer<TableParam.TableParamBuilder> f)

create a TableParam 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

Overrides:

forceLoad in class BaseParam

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Overrides:

delete in class BaseParam