Package com.apple.foundationdb.relational.api

Class RelationalStructMetaData

java.lang.Object

com.apple.foundationdb.relational.api.RelationalStructMetaData

All Implemented Interfaces:

StructMetaData, java.sql.Wrapper

@API(EXPERIMENTAL)
public class RelationalStructMetaData
extends java.lang.Object
implements StructMetaData

Constructor Summary

Constructors

Constructor	Description
RelationalStructMetaData(FieldDescription... columns)
RelationalStructMetaData(java.lang.String name, FieldDescription... columns)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
ArrayMetaData	getArrayMetaData(int oneBasedColumn)	Get the Metadata for an array type.
java.lang.String	getCatalogName(int oneBasedColumn)
int	getColumnCount()
java.lang.String	getColumnLabel(int oneBasedColumn)
java.lang.String	getColumnName(int oneBasedColumn)
int	getColumnType(int oneBasedColumn)
java.lang.String	getColumnTypeName(int oneBasedColumn)
java.util.List<FieldDescription>	getFields()
int	getLeadingPhantomColumnCount()
java.lang.String	getSchemaName(int oneBasedColumn)
StructMetaData	getStructMetaData(int oneBasedColumn)	Get the Metadata for a nested struct type.
java.lang.String	getTableName(int oneBasedColumn)
java.lang.String	getTypeName()	Returns the name of the struct type.
int	hashCode()
int	isNullable(int oneBasedColumn)
boolean	isWrapperFor(java.lang.Class<?> iface)
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationalStructMetaData

public RelationalStructMetaData(FieldDescription... columns)

RelationalStructMetaData

public RelationalStructMetaData(@Nonnull
                                java.lang.String name,
                                FieldDescription... columns)

Method Detail

getTypeName

public java.lang.String getTypeName()

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.

getColumnCount

public int getColumnCount()
                   throws java.sql.SQLException

Specified by:

getColumnCount in interface StructMetaData

Throws:

java.sql.SQLException

isNullable

public int isNullable(int oneBasedColumn)
               throws java.sql.SQLException

Specified by:

isNullable in interface StructMetaData

Throws:

java.sql.SQLException

getColumnLabel

public java.lang.String getColumnLabel(int oneBasedColumn)
                                throws java.sql.SQLException

Specified by:

getColumnLabel in interface StructMetaData

Throws:

java.sql.SQLException

getColumnName

public java.lang.String getColumnName(int oneBasedColumn)
                               throws java.sql.SQLException

Specified by:

getColumnName in interface StructMetaData

Throws:

java.sql.SQLException

getSchemaName

public java.lang.String getSchemaName(int oneBasedColumn)
                               throws java.sql.SQLException

Specified by:

getSchemaName in interface StructMetaData

Throws:

java.sql.SQLException

getTableName

public java.lang.String getTableName(int oneBasedColumn)
                              throws java.sql.SQLException

Specified by:

getTableName in interface StructMetaData

Throws:

java.sql.SQLException

getCatalogName

public java.lang.String getCatalogName(int oneBasedColumn)
                                throws java.sql.SQLException

Specified by:

getCatalogName in interface StructMetaData

Throws:

java.sql.SQLException

getColumnType

public int getColumnType(int oneBasedColumn)
                  throws java.sql.SQLException

Specified by:

getColumnType in interface StructMetaData

Throws:

java.sql.SQLException

getColumnTypeName

public java.lang.String getColumnTypeName(int oneBasedColumn)
                                   throws java.sql.SQLException

Specified by:

getColumnTypeName in interface StructMetaData

Throws:

java.sql.SQLException

getStructMetaData

public StructMetaData getStructMetaData(int oneBasedColumn)
                                 throws java.sql.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:

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

getArrayMetaData

public ArrayMetaData getArrayMetaData(int oneBasedColumn)
                               throws java.sql.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:

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

getLeadingPhantomColumnCount

public int getLeadingPhantomColumnCount()

Specified by:

getLeadingPhantomColumnCount in interface StructMetaData

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)

Specified by:

isWrapperFor in interface java.sql.Wrapper

getFields

@Nonnull
public java.util.List<FieldDescription> getFields()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object