Package org.ivoa.dm.vosi.tables

Class Atable

java.lang.Object

org.ivoa.dm.registry.vodataservice.Table

org.ivoa.dm.vosi.tables.Atable

All Implemented Interfaces:

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

@Entity
@VoDml(id="VOSITables:atable",
       role=objectType)
public class Atable
extends Table
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

A description of a single table supported by the service associated with a VOSI-enabled resource. objectType: Atable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Atable.AtableBuilder	A builder class for atable, mainly for use in the functional builder pattern.

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

Table.TableBuilder

Field Summary

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

_id, column, description, foreignKey, name, nrows, title, type, utype

Constructor Summary

Constructors

Constructor	Description
Atable()	Creates a new atable
Atable(String name, String title, String description, String utype, Integer nrows, List<TableParam> column, List<ForeignKey> foreignKey, String type)	full parameter constructor.
Atable(Table superinstance)	Constructor from supertype instance.
Atable(Atable other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
Table	copyMe()	make a clone of the object taking into account current polymorhic type.
static Atable	createAtable(Consumer<Atable.AtableBuilder> f)	create a atable in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
void	updateUsing(Atable other)	Update this object with the content of the given object.

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

addToColumn, addToForeignKey, createTable, getColumn, getDescription, getForeignKey, getId, getName, getNrows, getTitle, getType, getUtype, removeFromColumn, removeFromForeignKey, replaceInColumn, replaceInForeignKey, setColumn, setDescription, setForeignKey, setName, setNrows, setTitle, setType, setUtype, updateUsing, withDescription, withName, withNrows, withTitle, withType, 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

Constructor Details

Atable

public Atable()

Creates a new atable

Atable

public Atable(String name,
 String title,
 String description,
 String utype,
 Integer nrows,
 List<TableParam> column,
 List<ForeignKey> foreignKey,
 String type)

full parameter constructor.

Parameters:

name - The fully qualified name of the table. This name should include all catalogue or schema prefixes needed to sufficiently uniquely distinguish it in a query. In general, the format of the qualified name may depend on the context; however, when the table is intended to be queryable via ADQL, then the catalogue and schema qualifiers are delimited from the table name with dots (.).

title - A descriptive, human-interpretable name for the table. This is used for display purposes. There is no requirement regarding uniqueness.

description - A free-text description of the table's contents .

utype - An identifier for a concept in a data model that the data in this table 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).

nrows - The approximate size of the table in rows. This is not expected to be exact. For instance, the estimates on table sizes databases keep for query planning purposes are suitable for this field.

column - A description of a table column.

foreignKey - A description of a foreign keys, one or more columns from the current table that can be used to join with another table.

type - A name for the role this table plays. Recognized values include “output”, indicating this table is output from a query; “base_table”, indicating a table whose records represent the main subjects of its schema; and “view”, indicating that the table represents a useful combination or subset of other tables. Other values are allowed.

Atable

public Atable(Atable other)

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

Parameters:

other - the object to be copied.

Atable

public Atable(Table superinstance)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

Method Details

copyMe

public Table copyMe()

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

Overrides:

copyMe in class Table

Returns:

the cloned object.

updateUsing

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

createAtable

public static Atable createAtable(Consumer<Atable.AtableBuilder> f)

create a atable 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 Table

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

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

Overrides:

delete in class Table