com.avaje.ebeaninternal.server.type

Interface ScalarType<T>

All Superinterfaces:

ScalarDataReader<T>, StringFormatter, StringParser

All Known Implementing Classes:

ScalarTypeBase, ScalarTypeBaseDate, ScalarTypeBaseDateTime, ScalarTypeBaseVarchar, ScalarTypeBigDecimal, ScalarTypeBoolean.BitBoolean, ScalarTypeBoolean.BooleanBase, ScalarTypeBoolean.IntBoolean, ScalarTypeBoolean.Native, ScalarTypeBoolean.StringBoolean, ScalarTypeByte, ScalarTypeBytesBase, ScalarTypeBytesBinary, ScalarTypeBytesBlob, ScalarTypeBytesEncrypted, ScalarTypeBytesLongVarbinary, ScalarTypeBytesVarbinary, ScalarTypeCalendar, ScalarTypeChar, ScalarTypeCharArray, ScalarTypeClass, ScalarTypeClob, ScalarTypeCurrency, ScalarTypeDate, ScalarTypeDouble, ScalarTypeEncryptedWrapper, ScalarTypeEnumStandard.EnumBase, ScalarTypeEnumStandard.OrdinalEnum, ScalarTypeEnumStandard.StringEnum, ScalarTypeEnumWithMapping, ScalarTypeFloat, ScalarTypeInteger, ScalarTypeJodaDateMidnight, ScalarTypeJodaDateTime, ScalarTypeJodaLocalDate, ScalarTypeJodaLocalDateTime, ScalarTypeJodaLocalTime, ScalarTypeLocale, ScalarTypeLong, ScalarTypeLongToTimestamp, ScalarTypeLongVarchar, ScalarTypeMathBigInteger, ScalarTypeShort, ScalarTypeString, ScalarTypeTime, ScalarTypeTimestamp, ScalarTypeTimeZone, ScalarTypeURI, ScalarTypeURL, ScalarTypeUtilDate.DateType, ScalarTypeUtilDate.TimestampType, ScalarTypeUUID, ScalarTypeWrapper

public interface ScalarType<T>
extends StringParser, StringFormatter, ScalarDataReader<T>

Describes a scalar type.

Scalar in the sense that the types are not compound types. Scalar types only map to a single database column.

These types fall into two categories. Types that are mapped natively to JDBC types and the rest. Types that map to native JDBC types do not require any data type conversion to be persisted to the database. These are java types that map via java.sql.Types.

Types that are not native to JDBC require some conversion. These include some common java types such as java.util.Date, java.util.Calendar, java.math.BigInteger.

Note that Booleans may be native for some databases and require conversion on other databases.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(DataBind b, T value) Convert (if necessary) and bind the value to the preparedStatement.
String	format(Object v) Convert the type into a string representation.
String	formatValue(T v) Convert the type into a string representation.
int	getJdbcType() Return the type as per java.sql.Types that this maps to.
int	getLength() Return the default DB column length for this type.
Class<T>	getType() Return the type that matches the bean property type.
boolean	isDateTimeCapable() Return true if the type can accept long systemTimeMillis input.
boolean	isJdbcNative() Return true if the type is native to JDBC.
T	jsonFromString(String value, JsonValueAdapter ctx)
String	jsonToString(T value, JsonValueAdapter ctx)
void	jsonWrite(WriteJsonBuffer buffer, T value, JsonValueAdapter ctx)
void	loadIgnore(DataReader dataReader) Ignore the reading of this value.
T	parse(String value) Convert the string value to the appropriate java object.
T	parseDateTime(long dateTime) Convert the systemTimeMillis into the appropriate java object.
T	read(DataReader dataReader) Read the value from the resultSet and convert if necessary to the logical bean property value.
Object	readData(DataInput dataInput)
T	toBeanType(Object value) Convert the value as necessary to the logical Bean type.
Object	toJdbcType(Object value) Convert the value as necessary to the JDBC type.
void	writeData(DataOutput dataOutput, Object v)

Methods inherited from interface com.avaje.ebeaninternal.server.type.ScalarDataReader

accumulateScalarTypes

Method Detail

getLength

int getLength()

Return the default DB column length for this type.

If a BeanProperty has no explicit length defined then this length should be assigned.

This is primarily to support defining a length on Enum types (to supplement defining the length on the BeanProperty directly).

isJdbcNative

boolean isJdbcNative()

Return true if the type is native to JDBC.

If it is native to JDBC then its values/instances do not need to be converted to and from an associated JDBC type.

getJdbcType

int getJdbcType()

Return the type as per java.sql.Types that this maps to.

This type should be consistent with the toJdbcType() method in converting the type to the appropriate type for binding to preparedStatements.

getType

Class<T> getType()

Return the type that matches the bean property type.

This represents the 'logical' type rather than the JDBC type this maps to.

read

T read(DataReader dataReader)
       throws SQLException

Read the value from the resultSet and convert if necessary to the logical bean property value.

Specified by:

read in interface ScalarDataReader<T>

Throws:

SQLException

loadIgnore

void loadIgnore(DataReader dataReader)

Ignore the reading of this value. Typically this means moving the index position in the ResultSet.

Specified by:

loadIgnore in interface ScalarDataReader<T>

bind

void bind(DataBind b,
        T value)
          throws SQLException

Convert (if necessary) and bind the value to the preparedStatement.

value may need to be converted from the logical bean property type to the JDBC type.

Specified by:

bind in interface ScalarDataReader<T>

Throws:

SQLException

toJdbcType

Object toJdbcType(Object value)

Convert the value as necessary to the JDBC type.

Note that this should also match the type as per the getJdbcType() method.

This is typically used when the matching type is used in a where clause and we use this to ensure it is an appropriate jdbc type.

toBeanType

T toBeanType(Object value)

Convert the value as necessary to the logical Bean type.

The type as per the bean property.

This is used to automatically convert id values (typically from a string to a int, long or UUID).

formatValue

String formatValue(T v)

Convert the type into a string representation.

Reciprocal of parse().

format

String format(Object v)

Convert the type into a string representation.

This assumes the value is of the correct type.

This is so that ScalarType also implements the StringFormatter interface.

Specified by:

format in interface StringFormatter

parse

T parse(String value)

Convert the string value to the appropriate java object.

Mostly used to support CSV, JSON and XML parsing.

Reciprocal of formatValue().

Specified by:

parse in interface StringParser

parseDateTime

T parseDateTime(long dateTime)

Convert the systemTimeMillis into the appropriate java object.

For non dateTime types this will throw an exception.

isDateTimeCapable

boolean isDateTimeCapable()

Return true if the type can accept long systemTimeMillis input.

This is used to determine if is is sensible to use the parseDateTime(long) method.

This includes the Date, Calendar, sql Date, Time, Timestamp, JODA types as well as Long, BigDecimal and String (although it generally is not expected to parse systemTimeMillis to a String or BigDecimal).

jsonWrite

void jsonWrite(WriteJsonBuffer buffer,
             T value,
             JsonValueAdapter ctx)

jsonToString

String jsonToString(T value,
                  JsonValueAdapter ctx)

jsonFromString

T jsonFromString(String value,
               JsonValueAdapter ctx)

readData

Object readData(DataInput dataInput)
                throws IOException

Throws:

IOException

writeData

void writeData(DataOutput dataOutput,
             Object v)
               throws IOException

Throws:

IOException