io.requery.sql

Interface Mapping

All Known Implementing Classes:

GenericMapping

public interface Mapping

Defines the mapping between java class types and FieldType instances which determines how they are stored in a SQL database.

Method Summary

Modifier and Type	Method and Description
FieldType	mapAttribute(Attribute<?,?> attribute) Get the mapped storage type mapping for a given type Attribute.
<T> Mapping	putType(Class<? super T> type, FieldType<T> fieldType) Map a specific java class type to a FieldType instance.
<A> A	read(Expression<A> expression, ResultSet results, int column) Given the expression read it from ResultSet instance.
boolean	readBoolean(ResultSet results, int column) Reads a boolean value.
byte	readByte(ResultSet results, int column) Reads a byte value.
double	readDouble(ResultSet results, int column) Reads a double value.
float	readFloat(ResultSet results, int column) Reads a float value.
int	readInt(ResultSet results, int column) Reads a integer value.
long	readLong(ResultSet results, int column) Reads a long value.
short	readShort(ResultSet results, int column) Reads a boolean value.
<T> Mapping	replaceType(int sqlType, FieldType<T> replacementType) Replace the default mapping from a FieldType to a another FieldType.
Class<?>	typeOf(int sqlType) Get the mapped storage type mapping for a given sql type.
<A> void	write(Expression<A> expression, PreparedStatement statement, int index, A value) Given the expression bind it into a JDBC PreparedStatement.
void	writeBoolean(PreparedStatement statement, int index, boolean value) Sets a boolean value
void	writeByte(PreparedStatement statement, int index, byte value) Sets a byte value
void	writeDouble(PreparedStatement statement, int index, double value) Sets a double value
void	writeFloat(PreparedStatement statement, int index, float value) Sets a float value
void	writeInt(PreparedStatement statement, int index, int value) Sets a int value
void	writeLong(PreparedStatement statement, int index, long value) Sets a long value
void	writeShort(PreparedStatement statement, int index, short value) Sets a short value

Method Detail

putType

<T> Mapping putType(Class<? super T> type,
                    FieldType<T> fieldType)

Map a specific java class type to a FieldType instance.

Type Parameters:

T - the mapped type

Parameters:

type - non null java class type

fieldType - non null storage type

Returns:

mapping instance

replaceType

<T> Mapping replaceType(int sqlType,
                        FieldType<T> replacementType)

Replace the default mapping from a FieldType to a another FieldType. If the basic type is not mapped then a mapping will be added.

Type Parameters:

T - the mapped type

Parameters:

sqlType - Types to replace

replacementType - non null replacement type

Returns:

mapping instance

mapAttribute

FieldType mapAttribute(Attribute<?,?> attribute)

Get the mapped storage type mapping for a given type Attribute.

Parameters:

attribute - attribute non null attribute

Returns:

the mapped FieldType

typeOf

Class<?> typeOf(int sqlType)

Get the mapped storage type mapping for a given sql type.

Parameters:

sqlType - Types type

Returns:

the mapped class for the given sql type.

read

<A> A read(Expression<A> expression,
           ResultSet results,
           int column)
    throws SQLException

Given the expression read it from ResultSet instance.

Type Parameters:

A - type to read

Parameters:

expression - expression to read

results - ResultSet instance

column - column index

Returns:

the read type.

Throws:

SQLException - on a failure to read from the ResultSet

readBoolean

boolean readBoolean(ResultSet results,
                    int column)
             throws SQLException

Reads a boolean value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

readByte

byte readByte(ResultSet results,
              int column)
       throws SQLException

Reads a byte value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

readShort

short readShort(ResultSet results,
                int column)
         throws SQLException

Reads a boolean value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

readInt

int readInt(ResultSet results,
            int column)
     throws SQLException

Reads a integer value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

readLong

long readLong(ResultSet results,
              int column)
       throws SQLException

Reads a long value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

readFloat

float readFloat(ResultSet results,
                int column)
         throws SQLException

Reads a float value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

readDouble

double readDouble(ResultSet results,
                  int column)
           throws SQLException

Reads a double value.

Parameters:

results - ResultSet instance

column - column index

Returns:

read value

Throws:

SQLException - on a failure to read from the ResultSet

write

<A> void write(Expression<A> expression,
               PreparedStatement statement,
               int index,
               A value)
        throws SQLException

Given the expression bind it into a JDBC PreparedStatement.

Type Parameters:

A - type to be bound

Parameters:

expression - to bind

statement - prepared statement instance

index - statement index

value - value

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeBoolean

void writeBoolean(PreparedStatement statement,
                  int index,
                  boolean value)
           throws SQLException

Sets a boolean value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeByte

void writeByte(PreparedStatement statement,
               int index,
               byte value)
        throws SQLException

Sets a byte value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeShort

void writeShort(PreparedStatement statement,
                int index,
                short value)
         throws SQLException

Sets a short value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeInt

void writeInt(PreparedStatement statement,
              int index,
              int value)
       throws SQLException

Sets a int value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeLong

void writeLong(PreparedStatement statement,
               int index,
               long value)
        throws SQLException

Sets a long value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeFloat

void writeFloat(PreparedStatement statement,
                int index,
                float value)
         throws SQLException

Sets a float value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement

writeDouble

void writeDouble(PreparedStatement statement,
                 int index,
                 double value)
          throws SQLException

Sets a double value

Parameters:

statement - prepared statement

index - statement index

value - type to be bound

Throws:

SQLException - on a failure to set the expression on the PreparedStatement