tap.metadata

Class VotType

java.lang.Object

tap.metadata.VotType

public final class VotType
extends java.lang.Object

Describes a full VOTable type. Thus it includes the following field attributes:

• datatype,
• arraysize,
• xtype.

Version:

2.1 (03/2017)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VotType.VotDatatype All possible values for a VOTable datatype (i.e.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	arraysize Arraysize string of a VOTable field element.
VotType.VotDatatype	datatype VOTable datatype
java.lang.String	xtype Special type specification (i.e.
static java.lang.String	XTYPE_BLOB Special VOTable type (XType) for TAP/DB type BLOB.
static java.lang.String	XTYPE_CLOB Special VOTable type (XType) for TAP/DB type CLOB.
static java.lang.String	XTYPE_POINT Special VOTable type (XType) for TAP/DB type POINT.
static java.lang.String	XTYPE_REGION Special VOTable type (XType) for TAP/DB type REGION.
static java.lang.String	XTYPE_TIMESTAMP Special VOTable type (XType) for TAP/DB type TIMESTAMP.

Constructor Summary

Constructors

Constructor and Description
VotType(DBType tapType) Build a VotType object by converting the given DBType.
VotType(VotType.VotDatatype datatype, java.lang.String arraysize) Build a VOTable field type.
VotType(VotType.VotDatatype datatype, java.lang.String arraysize, java.lang.String xtype) Build a VOTable field type.

Method Summary

Modifier and Type	Method and Description
protected DBType	convertNumericType(DBType.DBDatatype tapDatatype) Convert this numeric VotType object into a corresponding DBType whose the datatype is provided in parameter.
protected DBType	convertVariableLengthType(DBType.DBDatatype varType, DBType.DBDatatype fixedType) Convert this variable length VotType (unsignedByte and char) object into a corresponding DBType whose the variable length and fixed length versions are given in parameters.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	toString()
DBType	toTAPType() Convert this VOTable type definition into a TAPColumn type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XTYPE_BLOB

public static final java.lang.String XTYPE_BLOB

Special VOTable type (XType) for TAP/DB type BLOB.

Since:

2.0

See Also:

Constant Field Values

XTYPE_CLOB

public static final java.lang.String XTYPE_CLOB

Special VOTable type (XType) for TAP/DB type CLOB.

Since:

2.0

See Also:

Constant Field Values

XTYPE_TIMESTAMP

public static final java.lang.String XTYPE_TIMESTAMP

Special VOTable type (XType) for TAP/DB type TIMESTAMP.

Since:

2.0

See Also:

Constant Field Values

XTYPE_POINT

public static final java.lang.String XTYPE_POINT

Special VOTable type (XType) for TAP/DB type POINT.

Since:

2.0

See Also:

Constant Field Values

XTYPE_REGION

public static final java.lang.String XTYPE_REGION

Special VOTable type (XType) for TAP/DB type REGION.

Since:

2.0

See Also:

Constant Field Values

datatype

public final VotType.VotDatatype datatype

VOTable datatype

Since:

2.0

arraysize

public final java.lang.String arraysize

Arraysize string of a VOTable field element.

xtype

public final java.lang.String xtype

Special type specification (i.e. POINT, TIMESTAMP, ...).

Constructor Detail

VotType

public VotType(VotType.VotDatatype datatype,
               java.lang.String arraysize)

Build a VOTable field type.

Parameters:

datatype - A datatype. Null value forbidden

arraysize - VOTable arraysize string (may be NULL).

VotType

public VotType(VotType.VotDatatype datatype,
               java.lang.String arraysize,
               java.lang.String xtype)

Build a VOTable field type.

Parameters:

datatype - A datatype. Null value forbidden

arraysize - VOTable arraysize string (may be NULL).

xtype - A special type (ex: adql:POINT, adql:TIMESTAMP, ...). (may be NULL).

VotType

public VotType(DBType tapType)

Build a VotType object by converting the given DBType.

Parameters:

tapType - DBType to convert.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toTAPType

public DBType toTAPType()
                 throws TAPException

Convert this VOTable type definition into a TAPColumn type.

Returns:

The corresponding DBType.

Throws:

TAPException - If the conversion is impossible (particularly if the array-size refers to a multi-dimensional array ; only 1D arrays are allowed).

convertNumericType

protected DBType convertNumericType(DBType.DBDatatype tapDatatype)

Convert this numeric VotType object into a corresponding DBType whose the datatype is provided in parameter.

Thus, just the arraysize must be managed here. If there is no arraysize or if equals to '1', the given datatype will be used. Otherwise, it is ignored and a DBType with VARBINARY is returned.

Parameters:

tapDatatype - TAP datatype corresponding to this VotType (only when arraysize != '*' and 'n').

Returns:

The corresponding DBType.

convertVariableLengthType

protected DBType convertVariableLengthType(DBType.DBDatatype varType,
                                           DBType.DBDatatype fixedType)
                                    throws TAPException

Convert this variable length VotType (unsignedByte and char) object into a corresponding DBType whose the variable length and fixed length versions are given in parameters.

Thus, just the arraysize must be managed here. The following cases are taken into account:

• No arraysize or '*': variable length type (i.e. VARCHAR, VARBINARY),
• 'n*': variable length type with the maximal length (i.e. VARCHAR(n), VARBINARY(n)),
• 'n': fixed length type with the exact length (i.e. CHAR(n), BINARY(n)).

Parameters:

varType - Variable length type (i.e. VARCHAR, VARBINARY).

fixedType - Fixed length type (i.e. CHAR, BINARY).

Returns:

The corresponding DBType.

Throws:

TAPException - If the arraysize is not valid (that's to say, different from the following syntaxes: NULL, '*', 'n' or 'n*' (where n is a positive and not-null integer)).