uk.org.ogsadai.tuple
Interface ColumnMetadata

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

SimpleColumnMetadata

public interface ColumnMetadata
extends java.io.Serializable

Interface defining the metadata of a column of an ODTuple.

Author:

The OGSA-DAI Project Team

Field Summary

static int	COLUMN_NO_NULLS The constant indicating that a column does not allow uk.org.ogsadai.tuple.Null values.
static int	COLUMN_NULLABLE The constant indicating that a column allows uk.org.ogsadai.tuple.Null values.
static int	COLUMN_NULLABLE_UNKNOWN The constant indicating that the nullability of a column's values is unknown.

Method Summary

int	getColumnDisplaySize() Indicates the designated column's normal maximum width in characters.
java.net.URI	getDRES() Gets URI of the Data Request Execution Service (DRES) that contains the data resource that contains the table that contains the column.
java.lang.String	getName() Gets the name of the column.
int	getPrecision() Gets the column precision.
ResourceID	getResourceID() Gets the ID of the data resource associate with the column.
java.lang.String	getTableName() Gets the table name associated with the column.
int	getType() Gets the column type.
int	isNullable() Indicates whether the column is nullable or not.

Field Detail

COLUMN_NO_NULLS

static final int COLUMN_NO_NULLS

The constant indicating that a column does not allow uk.org.ogsadai.tuple.Null values.

See Also:

Constant Field Values

COLUMN_NULLABLE

static final int COLUMN_NULLABLE

The constant indicating that a column allows uk.org.ogsadai.tuple.Null values.

See Also:

Constant Field Values

COLUMN_NULLABLE_UNKNOWN

static final int COLUMN_NULLABLE_UNKNOWN

The constant indicating that the nullability of a column's values is unknown.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Gets the name of the column.

Returns:

The column name

getTableName

java.lang.String getTableName()

Gets the table name associated with the column. This will be the name of the table in which the column originated.

Returns:

the name of the table, or null if the table name is unknown.

getResourceID

ResourceID getResourceID()

Gets the ID of the data resource associate with the column. This will be the resource that gives access to the table that contains the column.

Returns:

the resource ID of the data resource, or null if the resource ID is known.

getDRES

java.net.URI getDRES()

Gets URI of the Data Request Execution Service (DRES) that contains the data resource that contains the table that contains the column.

Returns:

the URI of the DRES, or null if the DRES URI is unknown.

getType

int getType()

Gets the column type.

Returns:

A tuple type from uk.org.ogsadai.tuple.TupleTypes

getPrecision

int getPrecision()

Gets the column precision.

Returns:

The column precision

isNullable

int isNullable()

Indicates whether the column is nullable or not.

Returns:

the nullability status of the given column; one of COLUMN_NO_NULLS, COLUMN_NULLABLE or COLUMN_NULLABLE_UNKNOWN.

getColumnDisplaySize

int getColumnDisplaySize()

Indicates the designated column's normal maximum width in characters.

Returns:

the normal maximum number of characters allowed as the width of the designated column