Module org.tentackle.sql

Package org.tentackle.sql.datatypes

Class BMoneyType

java.lang.Object

org.tentackle.sql.datatypes.AbstractDataType<org.tentackle.common.BMoney>

org.tentackle.sql.datatypes.BMoneyType

All Implemented Interfaces:

DataType<org.tentackle.common.BMoney>

@Service(DataType.class)
public class BMoneyType
extends AbstractDataType<org.tentackle.common.BMoney>

Datatype for BMoney.

Constructor Summary

Constructors

Constructor	Description
BMoneyType()

Method Summary

Modifier and Type	Method	Description
org.tentackle.common.BMoney	get(Backend backend, java.sql.ResultSet resultSet, int[] pos, boolean mapNull, java.lang.Integer size)	Gets the object from a result set. Must be implemented if DataType.isPredefined() returns false.
int	getColumnCount()	Gets the number of database columns. A tentackle type may be mapped to more than one column for multi-column types such as BMoney.
java.lang.String	getColumnGetter(int index)	Gets the java getter name of a column.
java.lang.Object	getColumnValue(int index, org.tentackle.common.BMoney value)	Gets the value of a column.
java.lang.String	getJavaType()	Gets the name of the Java type.
int	getScale(int index, java.lang.Integer scale)	Gets the column scale.
int	getSize(int index, java.lang.Integer size)	Gets the column size.
SqlType	getSqlType(int index)	Gets the SQL type.
boolean	isNumeric()	Returns whether this is a numeric type.
java.lang.Object[]	set(Backend backend, java.sql.PreparedStatement statement, int pos, org.tentackle.common.BMoney object, boolean mapNull, java.lang.Integer size)	Sets the object into a prepared statement. Must be implemented if DataType.isPredefined() returns false.
java.lang.Object	set(Backend backend, java.sql.PreparedStatement statement, int pos, org.tentackle.common.BMoney object, int index, boolean mapNull, java.lang.Integer size)	Sets a column of an object into a prepared statement. Must be implemented if DataType.isPredefined() returns false.
org.tentackle.common.BMoney	valueOf(java.lang.String str)	Parses a string and converts to the value of this type. The method is used to parse a literal (for example the default value defined in the model).

Methods inherited from class org.tentackle.sql.datatypes.AbstractDataType

equals, getColumnSuffix, getCommentSuffix, getDataTypeConstant, getVariant, hashCode, isBool, isDateOrTime, isDowncastNecessary, isJavaTypeGenerified, isLiteralSupported, isMapNullSupported, isModelProvidingInnerType, isMutable, isPredefined, isPrimitive, isUTCSupported, toLiteral, toNonPrimitive, toPrimitive, toString, toString, valueOfLiteralToCode

Methods inherited from class java.lang.Object

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

Constructor Detail

BMoneyType

public BMoneyType()

Method Detail

getJavaType

public java.lang.String getJavaType()

Description copied from interface: DataType

Gets the name of the Java type.

Returns:

the type

isNumeric

public boolean isNumeric()

Description copied from interface: DataType

Returns whether this is a numeric type.

Specified by:

isNumeric in interface DataType<org.tentackle.common.BMoney>

Overrides:

isNumeric in class AbstractDataType<org.tentackle.common.BMoney>

Returns:

true if numeric

getColumnCount

public int getColumnCount()

Description copied from interface: DataType

Gets the number of database columns.
A tentackle type may be mapped to more than one column for multi-column types such as BMoney.

Specified by:

getColumnCount in interface DataType<org.tentackle.common.BMoney>

Overrides:

getColumnCount in class AbstractDataType<org.tentackle.common.BMoney>

Returns:

default is 1

getSqlType

public SqlType getSqlType(int index)

Description copied from interface: DataType

Gets the SQL type.

Parameters:

index - the column index

Returns:

the SQL type

getSize

public int getSize(int index,
                   java.lang.Integer size)

Description copied from interface: DataType

Gets the column size.

Specified by:

getSize in interface DataType<org.tentackle.common.BMoney>

Overrides:

getSize in class AbstractDataType<org.tentackle.common.BMoney>

Parameters:

index - the column index

size - the size from the model

Returns:

the column size

getScale

public int getScale(int index,
                    java.lang.Integer scale)

Description copied from interface: DataType

Gets the column scale.

Specified by:

getScale in interface DataType<org.tentackle.common.BMoney>

Overrides:

getScale in class AbstractDataType<org.tentackle.common.BMoney>

Parameters:

index - the column index

scale - the scale from the model

Returns:

the column scale

getColumnValue

public java.lang.Object getColumnValue(int index,
                                       org.tentackle.common.BMoney value)

Description copied from interface: DataType

Gets the value of a column.

Specified by:

getColumnValue in interface DataType<org.tentackle.common.BMoney>

Overrides:

getColumnValue in class AbstractDataType<org.tentackle.common.BMoney>

Parameters:

index - the column index

value - the datatype's value according to the model

Returns:

the column's value

getColumnGetter

public java.lang.String getColumnGetter(int index)

Description copied from interface: DataType

Gets the java getter name of a column.

Specified by:

getColumnGetter in interface DataType<org.tentackle.common.BMoney>

Overrides:

getColumnGetter in class AbstractDataType<org.tentackle.common.BMoney>

Parameters:

index - the datatype's value according to the model

Returns:

the column's getter name, empty string if this is a single column type

valueOf

public org.tentackle.common.BMoney valueOf(java.lang.String str)

Description copied from interface: DataType

Parses a string and converts to the value of this type.
The method is used to parse a literal (for example the default value defined in the model).

Notice: the method doesn't use any locale, so the results are always the same regardless of the JVM's locale.

Parameters:

str - the source string

Returns:

the value

set

public java.lang.Object[] set(Backend backend,
                              java.sql.PreparedStatement statement,
                              int pos,
                              org.tentackle.common.BMoney object,
                              boolean mapNull,
                              java.lang.Integer size)
                       throws java.sql.SQLException

Description copied from interface: DataType

Sets the object into a prepared statement.
Must be implemented if DataType.isPredefined() returns false. Not invoked by framework otherwise.

Parameters:

backend - the database backend

statement - the prepared statement

pos - the position of the first SQL value

object - the object, may be null

mapNull - true if map null-values to non-null values

size - the optional size specified in the model

Returns:

the values stored in the prepared statement

Throws:

java.sql.SQLException - if failed

set

public java.lang.Object set(Backend backend,
                            java.sql.PreparedStatement statement,
                            int pos,
                            org.tentackle.common.BMoney object,
                            int index,
                            boolean mapNull,
                            java.lang.Integer size)
                     throws java.sql.SQLException

Description copied from interface: DataType

Sets a column of an object into a prepared statement.
Must be implemented if DataType.isPredefined() returns false. Not invoked by framework otherwise.

Specified by:

set in interface DataType<org.tentackle.common.BMoney>

Overrides:

set in class AbstractDataType<org.tentackle.common.BMoney>

Parameters:

backend - the database backend

statement - the prepared statement

pos - the position of the first SQL value

object - the object, may be null

index - the column index

mapNull - true if map null-values to non-null values

size - the optional size specified in the model

Returns:

the object stored in the prepared statement

Throws:

java.sql.SQLException - if failed

get

public org.tentackle.common.BMoney get(Backend backend,
                                       java.sql.ResultSet resultSet,
                                       int[] pos,
                                       boolean mapNull,
                                       java.lang.Integer size)
                                throws java.sql.SQLException

Description copied from interface: DataType

Gets the object from a result set.
Must be implemented if DataType.isPredefined() returns false. Not invoked by framework otherwise.

Parameters:

backend - the database backend

resultSet - the result set

pos - the column positions in the result set

mapNull - true if unmap null-values from non-null values

size - the optional size specified in the model

Returns:

the object or null if column(s) IS NULL

Throws:

java.sql.SQLException - if failed