Package org.ivoa.dm.tapschema

Class Column.ColumnBuilder

java.lang.Object

org.ivoa.dm.tapschema.Column.ColumnBuilder

Enclosing class:

Column

public static class Column.ColumnBuilder
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
String	arraysize	.
Integer	column_index	used to recommend table ordering for clients.
String	column_name	name of the column.
TAPType	datatype	the type of the column (VOTable semantics).
String	description	.
Boolean	indexed	does the column have an index.
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.
Boolean	std	is the column defined by a standard.
String	ucd	.
String	unit	.
String	utype	.
String	xtype	.

Constructor Summary

Constructors

Constructor	Description
ColumnBuilder()

Method Summary

Modifier and Type	Method	Description
Column	create()	create a column from this builder.

Methods inherited from class java.lang.Object

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

Field Details

column_name

public String column_name

name of the column.

datatype

public TAPType datatype

the type of the column (VOTable semantics).

arraysize

public String arraysize

.

xtype

public String xtype

.

description

public String description

.

utype

public String utype

.

unit

public String unit

.

ucd

public String ucd

.

indexed

public Boolean indexed

does the column have an index.

principal

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

std

public Boolean std

is the column defined by a standard.

column_index

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

Constructor Details

ColumnBuilder

public ColumnBuilder()

Method Details

create

public Column create()

create a column from this builder.

Returns:

an object initialized from the builder.