com.speedment.component.resultset

Interface ResultSetMapping<T>

Type Parameters:

T - Java type for this mapping

public interface ResultSetMapping<T>

Since:

2.0

Author:

pemi

Method Summary

Modifier and Type	Method and Description
Class<T>	getJavaClass() Returns the Java Class to use for this type mapping.
String	getResultSetMethodName(Dbms dbms) Returns the name of the ResultSet method to be used when getting data from a database.
default boolean	isMustUseSupportMethod() Returns if this type must use a support method to read from the ResulSet rather than just calling a ResultSet method directly (for example, there is no rs.getUuid() method).
T	parse(long input) Parses the given input long and returns an object of type T that corresponds to the given long.
T	parse(String input) Parses the given input String and returns an object of type T that corresponds to the given String.
static <T> T	unableToMap(Class<?> from, Class<T> to)
static <T> T	unableToMapLong(Class<T> clazz)
static <T> T	unableToMapString(Class<T> clazz)

Method Detail

getJavaClass

Class<T> getJavaClass()

Returns the Java Class to use for this type mapping.

Returns:

the Java Class to use for this type mapping

getResultSetMethodName

String getResultSetMethodName(Dbms dbms)

Returns the name of the ResultSet method to be used when getting data from a database. If, for example, the Java class Integer is used, then this method will return "Int" because an Integer can be read from a ResultSet with the method ResultSet.getInt(int). In some (rare) cases, the response might be different for different Dbms:es, so this is why the dmbs parameter needs to be provided.

Parameters:

dbms - to use

Returns:

the name of the ResultSet method to be used when getting data from a database.

parse

T parse(String input)

Parses the given input String and returns an object of type T that corresponds to the given String. This function is needed to be able to reconstruct Entity fields from JSON strings or change data logs for example.

Parameters:

input - the input String

Returns:

an Object of type T that corresponds to the given String

parse

T parse(long input)

Parses the given input long and returns an object of type T that corresponds to the given long. This function is needed to be able to reconstruct Entity fields that are auto increments in SQL tables. Typically, this method is only implemented for classes implementing the Number interface.

Parameters:

input - the input long

Returns:

an Object of type T that corresponds to the given String

unableToMapString

static <T> T unableToMapString(Class<T> clazz)

unableToMapLong

static <T> T unableToMapLong(Class<T> clazz)

unableToMap

static <T> T unableToMap(Class<?> from,
                         Class<T> to)

isMustUseSupportMethod

default boolean isMustUseSupportMethod()

Returns if this type must use a support method to read from the ResulSet rather than just calling a ResultSet method directly (for example, there is no rs.getUuid() method).

Returns:

if this type must use a support method to read from the ResulSet rather than just calling a ResultSet method directly