Package org.ivoa.dm.vosi.tables

Class Atable.AtableBuilder

java.lang.Object

org.ivoa.dm.vosi.tables.Atable.AtableBuilder

Enclosing class:

Atable

public static class Atable.AtableBuilder
extends Object

A builder class for atable, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
List<TableParam>	column	A description of a table column.
String	description	A free-text description of the table's contents .
List<ForeignKey>	foreignKey	A description of a foreign keys, one or more columns from the current table that can be used to join with another table.
String	name	The fully qualified name of the table.
Integer	nrows	The approximate size of the table in rows.
String	title	A descriptive, human-interpretable name for the table.
String	type	A name for the role this table plays.
String	utype	An identifier for a concept in a data model that the data in this table represent.

Constructor Summary

Constructors

Constructor	Description
AtableBuilder()

Method Summary

Modifier and Type	Method	Description
Atable	create()	create a atable from this builder.

Methods inherited from class java.lang.Object

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

Field Details

name

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

public String title

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

description

public String description

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

utype

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

public Integer 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

public List<TableParam> column

A description of a table column.

foreignKey

public List<ForeignKey> 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

public String 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.

Constructor Details

AtableBuilder

public AtableBuilder()

Method Details

create

public Atable create()

create a atable from this builder.

Returns:

an object initialized from the builder.