Package com.apple.foundationdb.relational.api

Class StructResultSetMetaData

java.lang.Object

com.apple.foundationdb.relational.api.StructResultSetMetaData

All Implemented Interfaces:

RelationalResultSetMetaData, StructMetaData, ResultSetMetaData, Wrapper

@API(EXPERIMENTAL)
public class StructResultSetMetaData
extends Object
implements RelationalResultSetMetaData

Field Summary

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Constructor Summary

Constructors

Constructor	Description
StructResultSetMetaData(StructMetaData metaData)

Method Summary

Modifier and Type	Method	Description
ArrayMetaData	getArrayMetaData(int oneBasedColumn)	Get the Metadata for an array type.
int	getColumnCount()
String	getColumnLabel(int column)
String	getColumnName(int column)
int	getColumnType(int column)
String	getColumnTypeName(int column)
DataType.StructType	getRelationalDataType()	Get the DataType object equivalent of this metadata.
StructMetaData	getStructMetaData(int oneBasedColumn)	Get the Metadata for a nested struct type.
String	getTypeName()	Returns the name of the struct type.
int	isNullable(int oneBasedColumn)
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.apple.foundationdb.relational.api.RelationalResultSetMetaData

getCatalogName, getColumnClassName, getColumnDisplaySize, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isReadOnly, isSearchable, isSigned, isWrapperFor, isWritable

Methods inherited from interface com.apple.foundationdb.relational.api.StructMetaData

getLeadingPhantomColumnCount

Constructor Details

StructResultSetMetaData

public StructResultSetMetaData(StructMetaData metaData)

Method Details

getTypeName

public String getTypeName()
                   throws SQLException

Description copied from interface: StructMetaData

Returns the name of the struct type. The user can set the struct type name in SQL explicitly by using struct <name> (...) clause.
For example: SELECT struct Foo (a, b) from T will give the struct (a, b) the name foo.

Specified by:

getTypeName in interface StructMetaData

Returns:

The name of the struct type.

Throws:

SQLException

getColumnCount

public int getColumnCount()
                   throws SQLException

Specified by:

getColumnCount in interface ResultSetMetaData

Specified by:

getColumnCount in interface StructMetaData

Throws:

SQLException

getColumnName

public String getColumnName(int column)
                     throws SQLException

Specified by:

getColumnName in interface ResultSetMetaData

Specified by:

getColumnName in interface StructMetaData

Throws:

SQLException

getColumnLabel

public String getColumnLabel(int column)
                      throws SQLException

Specified by:

getColumnLabel in interface RelationalResultSetMetaData

Specified by:

getColumnLabel in interface ResultSetMetaData

Specified by:

getColumnLabel in interface StructMetaData

Throws:

SQLException

getColumnType

public int getColumnType(int column)
                  throws SQLException

Specified by:

getColumnType in interface ResultSetMetaData

Specified by:

getColumnType in interface StructMetaData

Throws:

SQLException

getColumnTypeName

public String getColumnTypeName(int column)
                         throws SQLException

Specified by:

getColumnTypeName in interface RelationalResultSetMetaData

Specified by:

getColumnTypeName in interface ResultSetMetaData

Specified by:

getColumnTypeName in interface StructMetaData

Throws:

SQLException

getArrayMetaData

public ArrayMetaData getArrayMetaData(int oneBasedColumn)
                               throws SQLException

Description copied from interface: StructMetaData

Get the Metadata for an array type. If the column is not an array type, this will throw an error.

Specified by:

getArrayMetaData in interface StructMetaData

Parameters:

oneBasedColumn - the position of the column, indexed at 1

Returns:

the metadata for the array at column oneBasedColumn

Throws:

SQLException - if the type of the column is not an array, or if something else goes wrong.

getRelationalDataType

@Nonnull
public DataType.StructType getRelationalDataType()
                                          throws SQLException

Description copied from interface: StructMetaData

Get the DataType object equivalent of this metadata.

Specified by:

getRelationalDataType in interface StructMetaData

Returns:

the datatype object.

Throws:

SQLException - if something goes wrong.

getStructMetaData

public StructMetaData getStructMetaData(int oneBasedColumn)
                                 throws SQLException

Description copied from interface: StructMetaData

Get the Metadata for a nested struct type. If the column is not a struct type, this will throw an error.

Specified by:

getStructMetaData in interface StructMetaData

Parameters:

oneBasedColumn - the position of the column, indexed at 1

Returns:

the metadata for the struct at column oneBasedColumn

Throws:

SQLException - if the type of the column is not a struct, or if something else goes wrong.

isNullable

public int isNullable(int oneBasedColumn)
               throws SQLException

Specified by:

isNullable in interface RelationalResultSetMetaData

Specified by:

isNullable in interface ResultSetMetaData

Specified by:

isNullable in interface StructMetaData

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface RelationalResultSetMetaData

Specified by:

unwrap in interface Wrapper

Throws:

SQLException