com.j256.ormlite.field.types

Class UuidType

java.lang.Object

com.j256.ormlite.field.BaseFieldConverter

com.j256.ormlite.field.types.BaseDataType

com.j256.ormlite.field.types.UuidType

All Implemented Interfaces:

DataPersister, FieldConverter

Direct Known Subclasses:

NativeUuidType

public class UuidType
extends BaseDataType

Type that persists a UUID object using a database String. This is not to be confused with the native UUID types supported by some databases.

Author:

graywatson

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UuidType(SqlType sqlType)
protected	UuidType(SqlType sqlType, Class<?>[] classes) Here for others to subclass.

Method Summary

Modifier and Type	Method and Description
Object	generateId() Return a generated id if appropriate or null if none.
int	getDefaultWidth() Return the default width associated with this type or 0 if none.
static UuidType	getSingleton()
boolean	isSelfGeneratedId() Return true if this type creates its own generated ids else false to have the database do it.
boolean	isValidGeneratedType() Return true if this type can be auto-generated by the database.
Object	javaToSqlArg(FieldType fieldType, Object obj) Convert a Java object and return the appropriate argument to a SQL insert or update statement.
Object	parseDefaultString(FieldType fieldType, String defaultStr) Convert a default string object and return the appropriate argument to a SQL insert or update statement.
Object	resultToSqlArg(FieldType fieldType, DatabaseResults results, int columnPos) Return the SQL argument object extracted from the results associated with column in position columnPos.
Object	sqlArgToJava(FieldType fieldType, Object sqlArg, int columnPos) Return the object converted from the SQL arg to java.

Methods inherited from class com.j256.ormlite.field.types.BaseDataType

convertIdNumber, dataIsEqual, getAssociatedClasses, getAssociatedClassNames, getPrimaryClass, getSqlOtherType, getSqlType, isAppropriateId, isArgumentHolderRequired, isComparable, isEscapedDefaultValue, isEscapedValue, isPrimitive, isValidForField, isValidForVersion, makeConfigObject, moveToNextValue, resultStringToJava

Methods inherited from class com.j256.ormlite.field.BaseFieldConverter

isStreamType, resultToJava

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.j256.ormlite.field.FieldConverter

isStreamType, resultToJava

Field Detail

DEFAULT_WIDTH

public static int DEFAULT_WIDTH

Constructor Detail

UuidType

protected UuidType(SqlType sqlType)

UuidType

protected UuidType(SqlType sqlType,
                   Class<?>[] classes)

Here for others to subclass.

Method Detail

getSingleton

public static UuidType getSingleton()

parseDefaultString

public Object parseDefaultString(FieldType fieldType,
                                 String defaultStr)

Description copied from interface: FieldConverter

Convert a default string object and return the appropriate argument to a SQL insert or update statement.

Returns:

Result object to insert if the field is not specified or null if none.

resultToSqlArg

public Object resultToSqlArg(FieldType fieldType,
                             DatabaseResults results,
                             int columnPos)
                      throws SQLException

Description copied from interface: FieldConverter

Return the SQL argument object extracted from the results associated with column in position columnPos. For example, if the type is a date-long then this will return a long value or null.

Parameters:

fieldType - Associated FieldType which may be null.

Throws:

SQLException - If there is a problem accessing the results data.

sqlArgToJava

public Object sqlArgToJava(FieldType fieldType,
                           Object sqlArg,
                           int columnPos)
                    throws SQLException

Description copied from interface: FieldConverter

Return the object converted from the SQL arg to java. This takes the database representation and converts it into a Java object. For example, if the type is a date-long then this will take a long which is stored in the database and return a Date.

Specified by:

sqlArgToJava in interface FieldConverter

Overrides:

sqlArgToJava in class BaseFieldConverter

Parameters:

fieldType - Associated FieldType which may be null.

sqlArg - SQL argument converted with FieldConverter.resultToSqlArg(FieldType, DatabaseResults, int) which will not be null.

Throws:

SQLException - If there are problems with the conversion.

javaToSqlArg

public Object javaToSqlArg(FieldType fieldType,
                           Object obj)

Description copied from interface: FieldConverter

Convert a Java object and return the appropriate argument to a SQL insert or update statement.

Specified by:

javaToSqlArg in interface FieldConverter

Overrides:

javaToSqlArg in class BaseFieldConverter

isValidGeneratedType

public boolean isValidGeneratedType()

Description copied from interface: DataPersister

Return true if this type can be auto-generated by the database. Probably only numbers will return true.

Specified by:

isValidGeneratedType in interface DataPersister

Overrides:

isValidGeneratedType in class BaseDataType

isSelfGeneratedId

public boolean isSelfGeneratedId()

Description copied from interface: DataPersister

Return true if this type creates its own generated ids else false to have the database do it.

Specified by:

isSelfGeneratedId in interface DataPersister

Overrides:

isSelfGeneratedId in class BaseDataType

generateId

public Object generateId()

Description copied from interface: DataPersister

Return a generated id if appropriate or null if none.

Specified by:

generateId in interface DataPersister

Overrides:

generateId in class BaseDataType

getDefaultWidth

public int getDefaultWidth()

Description copied from interface: DataPersister

Return the default width associated with this type or 0 if none.

Specified by:

getDefaultWidth in interface DataPersister

Overrides:

getDefaultWidth in class BaseDataType