Package org.ivoa.dm.regtap

Class Table

java.lang.Object

org.ivoa.dm.regtap.Table

All Implemented Interfaces:

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

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

(Relational) tables that are part of schemata or resources. objectType: Table

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected Integer	nrows	An estimate for the number of rows in the table.
protected Integer	schema_index	Index of the schema this table belongs to, if it belongs to a schema (otherwise NULL).
protected String	table_description	A free-text description of the table's contents.
protected Integer	table_index	An arbitrary identifier for the tables belonging to a resource.
protected String	table_name	The fully qualified name of the table.
protected String	table_title	A descriptive, human-interpretable name for the table.
protected String	table_type	A name for the role this table plays.
protected String	table_utype	An identifier for a concept in a data model that the data in this table as a whole represent.

Constructor Summary

Constructors

Constructor	Description
Table()	Creates a new Table
Table(Integer schema_index, String table_description, String table_name, Integer table_index, String table_title, String table_type, String table_utype, Integer nrows)	full parameter constructor.
Table(Table other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static Table	createTable(Consumer<Table.TableBuilder> f)	create a Table in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
Long	getId()
Integer	getNrows()	Returns nrows Attribute.
Integer	getSchema_index()	Returns schema_index Attribute.
String	getTable_description()	Returns table_description Attribute.
Integer	getTable_index()	Returns table_index Attribute.
String	getTable_name()	Returns table_name Attribute.
String	getTable_title()	Returns table_title Attribute.
String	getTable_type()	Returns table_type Attribute.
String	getTable_utype()	Returns table_utype Attribute.
void	setNrows(Integer pNrows)	Set nrows Attribute.
void	setSchema_index(Integer pSchema_index)	Set schema_index Attribute.
void	setTable_description(String pTable_description)	Set table_description Attribute.
void	setTable_index(Integer pTable_index)	Set table_index Attribute.
void	setTable_name(String pTable_name)	Set table_name Attribute.
void	setTable_title(String pTable_title)	Set table_title Attribute.
void	setTable_type(String pTable_type)	Set table_type Attribute.
void	setTable_utype(String pTable_utype)	Set table_utype Attribute.
void	updateUsing(Table other)	Update this object with the content of the given object.
Table	withNrows(Integer pNrows)	fluent setter for nrows Attribute.
Table	withSchema_index(Integer pSchema_index)	fluent setter for schema_index Attribute.
Table	withTable_description(String pTable_description)	fluent setter for table_description Attribute.
Table	withTable_index(Integer pTable_index)	fluent setter for table_index Attribute.
Table	withTable_name(String pTable_name)	fluent setter for table_name Attribute.
Table	withTable_title(String pTable_title)	fluent setter for table_title Attribute.
Table	withTable_type(String pTable_type)	fluent setter for table_type Attribute.
Table	withTable_utype(String pTable_utype)	fluent setter for table_utype Attribute.

Methods inherited from class java.lang.Object

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

Field Details

_id

protected Long _id

inserted database key

schema_index

@VoDml(id="RegTAP:Table.schema_index",
       role=attribute,
       type="ivoa:nonnegativeInteger",
       typeRole=primitiveType)
protected Integer schema_index

Index of the schema this table belongs to, if it belongs to a schema (otherwise NULL). : Attribute schema_index : multiplicity 0..1

table_description

@VoDml(id="RegTAP:Table.table_description",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String table_description

A free-text description of the table's contents. : Attribute table_description : multiplicity 0..1

table_name

@VoDml(id="RegTAP:Table.table_name",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String table_name

The fully qualified name of the table. As per VODataService, this includes all catalog or schema prefixes needed to distinguish it in a query, and it comes with SQL delimiters where necessary. : Attribute table_name : multiplicity 1

table_index

@VoDml(id="RegTAP:Table.table_index",
       role=attribute,
       type="ivoa:nonnegativeInteger",
       typeRole=primitiveType)
protected Integer table_index

An arbitrary identifier for the tables belonging to a resource. : Attribute table_index : multiplicity 1

table_title

@VoDml(id="RegTAP:Table.table_title",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String table_title

A descriptive, human-interpretable name for the table. : Attribute table_title : multiplicity 0..1

table_type

@VoDml(id="RegTAP:Table.table_type",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String 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. : Attribute table_type : multiplicity 0..1

table_utype

@VoDml(id="RegTAP:Table.table_utype",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String table_utype

An identifier for a concept in a data model that the data in this table as a whole represent. : Attribute table_utype : multiplicity 0..1

nrows

@VoDml(id="RegTAP:Table.nrows",
       role=attribute,
       type="ivoa:nonnegativeInteger",
       typeRole=primitiveType)
protected Integer nrows

An estimate for the number of rows in the table. : Attribute nrows : multiplicity 0..1

Constructor Details

Table

public Table()

Creates a new Table

Table

public Table(Integer schema_index,
 String table_description,
 String table_name,
 Integer table_index,
 String table_title,
 String table_type,
 String table_utype,
 Integer nrows)

full parameter constructor.

Parameters:

schema_index - Index of the schema this table belongs to, if it belongs to a schema (otherwise NULL).

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

table_name - The fully qualified name of the table. As per VODataService, this includes all catalog or schema prefixes needed to distinguish it in a query, and it comes with SQL delimiters where necessary.

table_index - An arbitrary identifier for the tables belonging to a resource.

table_title - A descriptive, human-interpretable name for the table.

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.

table_utype - An identifier for a concept in a data model that the data in this table as a whole represent.

nrows - An estimate for the number of rows in the table.

Table

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

getSchema_index

public Integer getSchema_index()

Returns schema_index Attribute.

Returns:

schema_index Attribute

setSchema_index

public void setSchema_index(Integer pSchema_index)

Set schema_index Attribute.

Parameters:

pSchema_index - value to set

withSchema_index

public Table withSchema_index(Integer pSchema_index)

fluent setter for schema_index Attribute.

Parameters:

pSchema_index - value to set

Returns:

Table

getTable_description

public String getTable_description()

Returns table_description Attribute.

Returns:

table_description Attribute

setTable_description

public void setTable_description(String pTable_description)

Set table_description Attribute.

Parameters:

pTable_description - value to set

withTable_description

public Table withTable_description(String pTable_description)

fluent setter for table_description Attribute.

Parameters:

pTable_description - value to set

Returns:

Table

getTable_name

public String getTable_name()

Returns table_name Attribute.

Returns:

table_name Attribute

setTable_name

public void setTable_name(String pTable_name)

Set table_name Attribute.

Parameters:

pTable_name - value to set

withTable_name

public Table withTable_name(String pTable_name)

fluent setter for table_name Attribute.

Parameters:

pTable_name - value to set

Returns:

Table

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 Table withTable_index(Integer pTable_index)

fluent setter for table_index Attribute.

Parameters:

pTable_index - value to set

Returns:

Table

getTable_title

public String getTable_title()

Returns table_title Attribute.

Returns:

table_title Attribute

setTable_title

public void setTable_title(String pTable_title)

Set table_title Attribute.

Parameters:

pTable_title - value to set

withTable_title

public Table withTable_title(String pTable_title)

fluent setter for table_title Attribute.

Parameters:

pTable_title - value to set

Returns:

Table

getTable_type

public String getTable_type()

Returns table_type Attribute.

Returns:

table_type Attribute

setTable_type

public void setTable_type(String pTable_type)

Set table_type Attribute.

Parameters:

pTable_type - value to set

withTable_type

public Table withTable_type(String pTable_type)

fluent setter for table_type Attribute.

Parameters:

pTable_type - value to set

Returns:

Table

getTable_utype

public String getTable_utype()

Returns table_utype Attribute.

Returns:

table_utype Attribute

setTable_utype

public void setTable_utype(String pTable_utype)

Set table_utype Attribute.

Parameters:

pTable_utype - value to set

withTable_utype

public Table withTable_utype(String pTable_utype)

fluent setter for table_utype Attribute.

Parameters:

pTable_utype - value to set

Returns:

Table

getNrows

public Integer getNrows()

Returns nrows Attribute.

Returns:

nrows Attribute

setNrows

public void setNrows(Integer pNrows)

Set nrows Attribute.

Parameters:

pNrows - value to set

withNrows

public Table withNrows(Integer pNrows)

fluent setter for nrows Attribute.

Parameters:

pNrows - value to set

Returns:

Table

createTable

public static Table createTable(Consumer<Table.TableBuilder> f)

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