Module org.tentackle.sql

Package org.tentackle.sql.datatypes

Class LocalDateType

java.lang.Object

org.tentackle.sql.datatypes.AbstractDataType<T>

org.tentackle.sql.datatypes.AbstractDateTimeType<LocalDate>

org.tentackle.sql.datatypes.LocalDateType

All Implemented Interfaces:

DataType<LocalDate>

@Service(DataType.class)
public final class LocalDateType
extends AbstractDateTimeType<LocalDate>

Datatype for LocalDate.

Mapped to Date-related JDBC methods.

Field Summary

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

maxLinesInLiteral

Constructor Summary

Constructors

Constructor	Description
LocalDateType()	Creates the datatype for LocalDate.

Method Summary

Modifier and Type	Method	Description
String	format(LocalDate date)	Converts a date object to a string.
LocalDate	get(Backend backend, ResultSet resultSet, int[] pos, boolean mapNull, Integer size)	Gets the object from a result set. Must be implemented if DataType.isPredefined() returns false.
String	getJavaType()	Gets the name of the Java type.
SqlType	getSqlType(Backend backend, int index)	Gets the SQL type. For predefined types, the type must be the same for all backends and the backend argument may be null. Application specific types, however, can use different sql types for different backends and for those types the backend argument is always valid.
boolean	isMapNullSupported()	Returns whether this type supports mapping null values to some well-defined constant.
LocalDate	parse(String str)	Converts a string to a local date.
Object[]	set(Backend backend, PreparedStatement statement, int pos, LocalDate object, boolean mapNull, Integer size)	Sets the object into a prepared statement. Must be implemented if DataType.isPredefined() returns false.
String	toString(LocalDate object)	Takes an object and converts it to a string that can in turn be parsed with DataType.valueOf(String). The method is used to print a literal (for example the default value of a dumped attribute).
LocalDate	valueOf(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.AbstractDateTimeType

isDateOrTime, valueOfLiteralToCode

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

assertColumnCountNotBackendSpecific, createColumnNames, createColumnNamesAsString, equals, getColumnAlias, getColumnCount, getColumnGetter, getColumnSuffix, getColumnValue, getCommentSuffix, getDataTypeConstant, getMappedNullValue, getScale, getSize, getSortableColumns, getVariant, hashCode, isBool, isColumnCountBackendSpecific, isDowncastNecessary, isJavaTypeGenerified, isLiteralSupported, isModelProvidingInnerType, isMutable, isNumeric, isPredefined, isPrimitive, isTimezoneApplicable, isUTCSupported, set, toLiteral, toNonPrimitive, toPrimitive, toString, valueStringToCode

Methods inherited from class java.lang.Object

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

Constructor Details

LocalDateType

public LocalDateType()

Creates the datatype for LocalDate.

Method Details

getJavaType

public String getJavaType()

Description copied from interface: DataType

Gets the name of the Java type.

Returns:

the type

isMapNullSupported

public boolean isMapNullSupported()

Description copied from interface: DataType

Returns whether this type supports mapping null values to some well-defined constant.

Specified by:

isMapNullSupported in interface DataType<LocalDate>

Overrides:

isMapNullSupported in class AbstractDataType<LocalDate>

Returns:

true if mapNull supported

getSqlType

public SqlType getSqlType(Backend backend,
 int index)

Description copied from interface: DataType

Gets the SQL type.
For predefined types, the type must be the same for all backends and the backend argument may be null.
Application specific types, however, can use different sql types for different backends and for those types the backend argument is always valid.

Parameters:

backend - the backend, not used by predefined types

index - the column index

Returns:

the SQL type

valueOf

public LocalDate valueOf(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

toString

public String toString(LocalDate object)

Description copied from interface: DataType

Takes an object and converts it to a string that can in turn be parsed with DataType.valueOf(String).
The method is used to print a literal (for example the default value of a dumped attribute).

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

Specified by:

toString in interface DataType<LocalDate>

Overrides:

toString in class AbstractDataType<LocalDate>

Parameters:

object - the object of this DataType

Returns:

the printable string

set

public Object[] set(Backend backend,
 PreparedStatement statement,
 int pos,
 LocalDate object,
 boolean mapNull,
 Integer size)
             throws 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:

SQLException - if failed

get

public LocalDate get(Backend backend,
 ResultSet resultSet,
 int[] pos,
 boolean mapNull,
 Integer size)
              throws 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:

SQLException - if failed

parse

public LocalDate parse(String str)
                throws BackendException

Converts a string to a local date.

Parameters:

str - the string

Returns:

the date

Throws:

BackendException - if parsing failed

format

public String format(LocalDate date)

Converts a date object to a string.

Parameters:

date - the date

Returns:

the formatted string