Package com.apple.foundationdb.relational.api

Class RelationalArrayMetaData

java.lang.Object

com.apple.foundationdb.relational.api.RelationalArrayMetaData

All Implemented Interfaces:

ArrayMetaData, java.sql.Wrapper

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

Metadata describing what is in a RelationalArray.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
ArrayMetaData	getElementArrayMetaData()	Get the Metadata for an array type.
FieldDescription	getElementField()
java.lang.String	getElementName()
StructMetaData	getElementStructMetaData()	Get the Metadata for a nested struct type.
int	getElementType()
java.lang.String	getElementTypeName()
int	hashCode()
int	isElementNullable()
boolean	isWrapperFor(java.lang.Class<?> iface)
static RelationalArrayMetaData	ofPrimitive(int sqlType, int nullable)
static RelationalArrayMetaData	ofStruct(StructMetaData metaData, int nullable)
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

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

Method Detail

ofPrimitive

public static RelationalArrayMetaData ofPrimitive(int sqlType,
                                                  int nullable)

ofStruct

public static RelationalArrayMetaData ofStruct(@Nonnull
                                               StructMetaData metaData,
                                               int nullable)

isElementNullable

public int isElementNullable()
                      throws java.sql.SQLException

Specified by:

isElementNullable in interface ArrayMetaData

Throws:

java.sql.SQLException

getElementName

public java.lang.String getElementName()
                                throws java.sql.SQLException

Specified by:

getElementName in interface ArrayMetaData

Throws:

java.sql.SQLException

getElementType

public int getElementType()
                   throws java.sql.SQLException

Specified by:

getElementType in interface ArrayMetaData

Throws:

java.sql.SQLException

getElementTypeName

public java.lang.String getElementTypeName()
                                    throws java.sql.SQLException

Specified by:

getElementTypeName in interface ArrayMetaData

Throws:

java.sql.SQLException

getElementStructMetaData

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

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

getElementArrayMetaData

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

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

getElementField

@Nonnull
public FieldDescription getElementField()

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

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