Package com.apple.foundationdb.relational.api

Interface RelationalStruct

All Superinterfaces:

Struct, WithMetadata, Wrapper

All Known Subinterfaces:

RelationalResultSet

public interface RelationalStruct
extends Struct, Wrapper, WithMetadata

A Struct but with metadata describing the instance.

Method Summary

Modifier and Type	Method	Description
RelationalArray	getArray(int oneBasedPosition)
RelationalArray	getArray(String fieldName)
default Object[]	getAttributes()
default Object[]	getAttributes(Map<String,Class<?>> map)
boolean	getBoolean(int oneBasedPosition)
boolean	getBoolean(String fieldName)
byte[]	getBytes(int oneBasedPosition)
byte[]	getBytes(String fieldName)
double	getDouble(int oneBasedPosition)
double	getDouble(String fieldName)
float	getFloat(int oneBasedPosition)
float	getFloat(String fieldName)
int	getInt(int oneBasedPosition)
int	getInt(String fieldName)
long	getLong(int oneBasedPosition)
long	getLong(String fieldName)
StructMetaData	getMetaData()
Object	getObject(int oneBasedPosition)
Object	getObject(String fieldName)
static int	getOneBasedPosition(String columnName, RelationalStruct relationalStruct)	Utility for figuring out one-based-position of a column when passed columnName.
default DataType	getRelationalMetaData()
default String	getSQLTypeName()
String	getString(int oneBasedPosition)
String	getString(String fieldName)
RelationalStruct	getStruct(int oneBasedPosition)
RelationalStruct	getStruct(String fieldName)
UUID	getUUID(int oneBasedPosition)
UUID	getUUID(String fieldName)
default boolean	isWrapperFor(Class<?> iface)
default <T> T	unwrap(Class<T> iface)
boolean	wasNull()	Reports whether the last column read had a value of SQL NULL.

Method Details

getMetaData

StructMetaData getMetaData()
                    throws SQLException

Throws:

SQLException

getBoolean

boolean getBoolean(int oneBasedPosition)
            throws SQLException

Throws:

SQLException

getBoolean

boolean getBoolean(String fieldName)
            throws SQLException

Throws:

SQLException

getInt

int getInt(int oneBasedPosition)
    throws SQLException

Throws:

SQLException

getInt

int getInt(String fieldName)
    throws SQLException

Throws:

SQLException

getLong

long getLong(int oneBasedPosition)
      throws SQLException

Throws:

SQLException

getLong

long getLong(String fieldName)
      throws SQLException

Throws:

SQLException

getFloat

float getFloat(int oneBasedPosition)
        throws SQLException

Throws:

SQLException

getFloat

float getFloat(String fieldName)
        throws SQLException

Throws:

SQLException

getDouble

double getDouble(int oneBasedPosition)
          throws SQLException

Throws:

SQLException

getDouble

double getDouble(String fieldName)
          throws SQLException

Throws:

SQLException

getBytes

byte[] getBytes(int oneBasedPosition)
         throws SQLException

Throws:

SQLException

getBytes

byte[] getBytes(String fieldName)
         throws SQLException

Throws:

SQLException

getString

String getString(int oneBasedPosition)
          throws SQLException

Throws:

SQLException

getString

String getString(String fieldName)
          throws SQLException

Throws:

SQLException

getObject

Object getObject(int oneBasedPosition)
          throws SQLException

Throws:

SQLException

getObject

Object getObject(String fieldName)
          throws SQLException

Throws:

SQLException

getStruct

RelationalStruct getStruct(int oneBasedPosition)
                    throws SQLException

Throws:

SQLException

getStruct

RelationalStruct getStruct(String fieldName)
                    throws SQLException

Throws:

SQLException

getArray

RelationalArray getArray(int oneBasedPosition)
                  throws SQLException

Throws:

SQLException

getArray

RelationalArray getArray(String fieldName)
                  throws SQLException

Throws:

SQLException

getUUID

UUID getUUID(int oneBasedPosition)
      throws SQLException

Throws:

SQLException

getUUID

UUID getUUID(String fieldName)
      throws SQLException

Throws:

SQLException

wasNull

boolean wasNull()
         throws SQLException

Reports whether the last column read had a value of SQL NULL. See ResultSet.wasNull()

Throws:

SQLException

getSQLTypeName

default String getSQLTypeName()
                       throws SQLException

Specified by:

getSQLTypeName in interface Struct

Throws:

SQLException

getAttributes

default Object[] getAttributes()
                        throws SQLException

Specified by:

getAttributes in interface Struct

Throws:

SQLException

getAttributes

default Object[] getAttributes(Map<String,Class<?>> map)
                        throws SQLException

Specified by:

getAttributes in interface Struct

Throws:

SQLException

unwrap

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

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

default boolean isWrapperFor(Class<?> iface)
                      throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

getRelationalMetaData

@Nonnull
default DataType getRelationalMetaData()
                                throws SQLException

Specified by:

getRelationalMetaData in interface WithMetadata

Throws:

SQLException

getOneBasedPosition

static int getOneBasedPosition(String columnName,
 RelationalStruct relationalStruct)
                        throws SQLException

Utility for figuring out one-based-position of a column when passed columnName.

Parameters:

columnName - Name to lookup.

relationalStruct - Where to do the lookup.

Returns:

One-based positional index to use accessing the column.

Throws:

SQLException - Thrown if we can't find matching column of we have trouble getting metadata.