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

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

public class Column
extends java.lang.Object

A description of a table column.

See Also:

Table, ForeignKey

Field Summary

protected java.util.List<java.lang.String>

flagList

Constructor Summary

protected	Column() Constructs a Column object.
protected	Column(java.lang.String name, java.lang.String description, java.lang.String unit, java.lang.String ucd, java.lang.String utype, java.lang.String dataType, java.lang.String arraySize, java.lang.String delim, java.lang.String extendedType, java.lang.String extendedSchema, java.util.List<java.lang.String> flags, boolean std) Constructs a Column object.

Method Summary

java.lang.String	getArraySize() Returns the column arraysize.
java.lang.String	getDataType() Returns the column datatype
java.lang.String	getDelim() Returns the column delimiter.
java.lang.String	getDescription() Returns the column description.
java.lang.String	getExtendedSchema() Returns the column extended schema identifier.
java.lang.String	getExtendedType() Returns the column extended type.
java.util.List<java.lang.String>	getFlags() Returns a list of keywords representing traits of the column as defined in the VODataService recommendation.
java.lang.String	getName() Returns the column name.
java.lang.String	getUcd() Returns the column UCD.
java.lang.String	getUnit() Returns the column unit.
java.lang.String	getUtype() Returns the column utype, usage-specific or unique type.
boolean	isIndexed() Returns true if this column has been identified as being part of an index.
boolean	isPrimary() Returns true if this column has been identified as part of the primary key for a table.
boolean	isStd() Returns true if this column has been identified as being reserver or defined by a VO standard interface.
void	list(java.io.PrintStream output)
void	list(java.io.PrintStream output, java.lang.String indent)
java.lang.String	toString() Returns a String representation of this Column object.

Methods inherited from class java.lang.Object

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

Field Detail

flagList

protected java.util.List<java.lang.String> flagList

Constructor Detail

Column

protected Column()

Constructs a Column object. For use by subclasses.

Column

protected Column(java.lang.String name,
                 java.lang.String description,
                 java.lang.String unit,
                 java.lang.String ucd,
                 java.lang.String utype,
                 java.lang.String dataType,
                 java.lang.String arraySize,
                 java.lang.String delim,
                 java.lang.String extendedType,
                 java.lang.String extendedSchema,
                 java.util.List<java.lang.String> flags,
                 boolean std)

Constructs a Column object. For use by subclasses.

Method Detail

getName

public java.lang.String getName()

Returns the column name.

Returns:

the name of this Column

getDescription

public java.lang.String getDescription()

Returns the column description.

Returns:

a description of this Column or null if not defined

getUnit

public java.lang.String getUnit()

Returns the column unit.

Returns:

the units of this Column or null if not defined

getUcd

public java.lang.String getUcd()

Returns the column UCD.

Returns:

the uniform content description (UCD) of this column for null if not defined

getUtype

public java.lang.String getUtype()

Returns the column utype, usage-specific or unique type.

Returns:

the uniform content description (UCD) of this column for null if not defined

getDataType

public java.lang.String getDataType()

Returns the column datatype

Returns:

the datatype of this column for null if not defined

getArraySize

public java.lang.String getArraySize()

Returns the column arraysize.

Returns:

the arraysize of this column for null if not defined

getDelim

public java.lang.String getDelim()

Returns the column delimiter.

Returns:

the element delimiter of this column if it is an array or for null if not defined

getExtendedType

public java.lang.String getExtendedType()

Returns the column extended type.

Returns:

the extended type of this column for null if not defined

getExtendedSchema

public java.lang.String getExtendedSchema()

Returns the column extended schema identifier.

Returns:

the extended schema of this column for null if not defined

getFlags

public java.util.List<java.lang.String> getFlags()

Returns a list of keywords representing traits of the column as defined in the VODataService recommendation. Possible values listed in the VODataService Recommendation include:

• indexed The column has an index on it for faster search against its values.
• primary The values column in the column represents in total or in part a primary key for its table.
• nullable The column may contain null or empty values.

Other values are allowed.

Returns:

a list of flags for this column.

isStd

public boolean isStd()

Returns true if this column has been identified as being reserver or defined by a VO standard interface.

Returns:

true if the meaning of this column is reserved or defined by a standard interface, false otherwise.

isPrimary

public boolean isPrimary()

Returns true if this column has been identified as part of the primary key for a table.

Returns:

true if the column is part of a primary key, false otherwise.

isIndexed

public boolean isIndexed()

Returns true if this column has been identified as being part of an index.

Returns:

true if the column is part of an index, false otherwise.

toString

public java.lang.String toString()

Returns a String representation of this Column 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 representaion of this object.

list

public void list(java.io.PrintStream output)

list

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