Package com.apple.foundationdb.relational.api

Class RelationalArrayMetaData

java.lang.Object

com.apple.foundationdb.relational.api.RelationalArrayMetaData

All Implemented Interfaces:

ArrayMetaData, Wrapper

@API(EXPERIMENTAL)
public final class RelationalArrayMetaData
extends Object
implements ArrayMetaData

Metadata describing what is in a RelationalArray.

Method Summary

Modifier and Type	Method	Description
DataType.ArrayType	asRelationalType()	Get the DataType object equivalent of this metadata.
boolean	equals(Object other)
ArrayMetaData	getElementArrayMetaData()	Get the Metadata for an array type.
DataType	getElementDataType()
String	getElementName()
StructMetaData	getElementStructMetaData()	Get the Metadata for a nested struct type.
int	getElementType()
String	getElementTypeName()
int	hashCode()
int	isElementNullable()
boolean	isWrapperFor(Class<?> iface)
static RelationalArrayMetaData	of(DataType.ArrayType type)
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Method Details

of

@Nonnull
public static RelationalArrayMetaData of(@Nonnull
 DataType.ArrayType type)

isElementNullable

public int isElementNullable()

Specified by:

isElementNullable in interface ArrayMetaData

getElementName

public String getElementName()
                      throws SQLException

Specified by:

getElementName in interface ArrayMetaData

Throws:

SQLException

getElementType

public int getElementType()
                   throws SQLException

Specified by:

getElementType in interface ArrayMetaData

Throws:

SQLException

getElementTypeName

public String getElementTypeName()

Specified by:

getElementTypeName in interface ArrayMetaData

getElementStructMetaData

public StructMetaData getElementStructMetaData()
                                        throws SQLException

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

Specified by:

getElementStructMetaData in interface ArrayMetaData

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.

getElementArrayMetaData

public ArrayMetaData getElementArrayMetaData()
                                      throws SQLException

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

Specified by:

getElementArrayMetaData in interface ArrayMetaData

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.

asRelationalType

@Nonnull
public DataType.ArrayType asRelationalType()
                                    throws SQLException

Description copied from interface: ArrayMetaData

Get the DataType object equivalent of this metadata.

Specified by:

asRelationalType in interface ArrayMetaData

Returns:

the datatype object.

Throws:

SQLException - if something goes wrong.

getElementDataType

@Nonnull
public DataType getElementDataType()

unwrap

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

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)

Specified by:

isWrapperFor in interface Wrapper

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object