Module storm

Package st.orm.spi

Interface ORMConverter

public interface ORMConverter

Interface for converting ORM parameters to SQL parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ORMConverter.NameResolver	Interface for resolving names of record components.

Method Summary

Modifier and Type	Method	Description
Object	fromDatabase(Object[] values)	Converts the given values to an object that is used in the object model.
List<Name>	getColumns(ORMConverter.NameResolver nameResolver)	Returns the names of the columns that will be used in the SQL template.
default int	getParameterCount()	Returns the number of parameters in the SQL template.
List<Class<?>>	getParameterTypes()	Returns the types of the parameters in the SQL template.
List<Object>	toDatabase(Record record)	Converts the given record to a list of values that can be used in the SQL template.

Method Details

getParameterCount

default int getParameterCount()
                       throws SqlTemplateException

Returns the number of parameters in the SQL template.

Note: the count must match the parameter as returned by getParameterTypes().

Returns:

the number of parameters.

Throws:

SqlTemplateException

getParameterTypes

List<Class<?>> getParameterTypes()
                          throws SqlTemplateException

Returns the types of the parameters in the SQL template.

Returns:

a list of parameter types.

Throws:

SqlTemplateException

getColumns

List<Name> getColumns(@Nonnull
 ORMConverter.NameResolver nameResolver)
               throws SqlTemplateException

Returns the names of the columns that will be used in the SQL template.

Note: the names must match the parameters as returned by getParameterTypes().

Returns:

a list of column names.

Throws:

SqlTemplateException

toDatabase

List<Object> toDatabase(@Nullable
 Record record)
                 throws SqlTemplateException

Converts the given record to a list of values that can be used in the SQL template.

Note: the values must match the parameters as returned by getParameterTypes().

Parameters:

record - the record to convert.

Returns:

the values to be used in the SQL template.

Throws:

SqlTemplateException

fromDatabase

Object fromDatabase(@Nonnull
 Object[] values)
             throws SqlTemplateException

Converts the given values to an object that is used in the object model.

Parameters:

values - the arguments to convert. The arguments match the parameter types as returned by getParameterTypes().

Returns:

the converted object.

Throws:

SqlTemplateException - if an error occurs during conversion.