edu.harvard.cfa.vo.tapclient.vosi
Class Table

java.lang.Object
  edu.harvard.cfa.vo.tapclient.vosi.Table

public class Table
extends java.lang.Object

A description of one of the tables that makes up the set.

See Also:

Schema

Constructor Summary

protected	Table() Constructs a Table object.
protected	Table(java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String utype, java.util.List<Column> columns, java.util.List<ForeignKey> foreignKeys, java.lang.String type) Constructs a Table object.

Method Summary

protected void	add(Column newValue)
protected void	add(ForeignKey newValue)
java.util.List<Column>	getColumns() Returns a List of Column objects representing the columns provided for the table.
java.lang.String	getDescription() Returns the description provided for the table.
java.util.List<ForeignKey>	getForeignKeys() Returns a list of ForeignKey objects.
java.util.List<Column>	getIndexedColumns() Return a list of indexed columns or an empty list if no indexed columns were specified.
java.lang.String	getName() Returns the name provided for the table.
java.util.List<Column>	getPrimaryKeys() Returns a list of primary key columns or an empty list if no primary key columns are identified.
java.lang.String	getTitle() Returns the title provided for the table.
java.lang.String	getType() Returns the table type as provided for the table.
java.lang.String	getUtype() Returns the utype, usage-specific or unique type, provided for the table
void	list(java.io.PrintStream output)
void	list(java.io.PrintStream output, java.lang.String indent)
java.lang.String	toString() Return a String representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

protected Table()

Constructs a Table object. For subclasses.

Table

protected Table(java.lang.String name,
                java.lang.String title,
                java.lang.String description,
                java.lang.String utype,
                java.util.List<Column> columns,
                java.util.List<ForeignKey> foreignKeys,
                java.lang.String type)

Constructs a Table object. For subclasses.

Method Detail

getName

public java.lang.String getName()

Returns the name provided for the table.

Returns:

the table name or null if not specify by the service.

getTitle

public java.lang.String getTitle()

Returns the title provided for the table.

Returns:

the table title or null if not specify by the service.

getDescription

public java.lang.String getDescription()

Returns the description provided for the table.

Returns:

the table description or null if not specify by the service.

getUtype

public java.lang.String getUtype()

Returns the utype, usage-specific or unique type, provided for the table

Returns:

the table utype or null if not specify by the service.

getColumns

public java.util.List<Column> getColumns()

Returns a List of Column objects representing the columns provided for the table.

Returns:

a list of table columns

add

protected void add(Column newValue)

getIndexedColumns

public java.util.List<Column> getIndexedColumns()

Return a list of indexed columns or an empty list if no indexed columns were specified. This list is constructed based on column metadata provided by the service.

Returns:

a list of indexed columns or an empty list if no indexed columns were identified.

See Also:

Column.isIndexed()

getPrimaryKeys

public java.util.List<Column> getPrimaryKeys()

Returns a list of primary key columns or an empty list if no primary key columns are identified.

Returns:

a list of columns constituting the primary key or an empty list if no primary key columns were specified.

See Also:

Column.isPrimary()

getForeignKeys

public java.util.List<ForeignKey> getForeignKeys()

Returns a list of ForeignKey objects.

Returns:

a list of foreign keys

add

protected void add(ForeignKey newValue)

getType

public java.lang.String getType()

Returns the table type as provided for the table. The VODataService Recommendation notes that "table" or "view" may be possible values.

Returns:

the table type or null if not specified by the service.

toString

public java.lang.String toString()

Return a String representation of this object. This method is intended to be used only for debugging purposes, and the format of the returned string may vary between implementations.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Table object

list

public void list(java.io.PrintStream output)

list

public void list(java.io.PrintStream output,
                 java.lang.String indent)