com.j256.ormlite.field.types

Class BooleanCharType

java.lang.Object

com.j256.ormlite.field.BaseFieldConverter

com.j256.ormlite.field.types.BaseDataType

com.j256.ormlite.field.types.BooleanObjectType

com.j256.ormlite.field.types.BooleanType

com.j256.ormlite.field.types.BooleanCharType

All Implemented Interfaces:

DataPersister, FieldConverter

public class BooleanCharType
extends BooleanType

Booleans can be stored in the database as the character '1' '0'. You can change the characters by specifying a format string. It must be a string with 2 characters. The first character is the value for TRUE, the second is FALSE. You must choose this DataType specifically with the DatabaseField.dataType() specifier.

 @DatabaseField(format = "YN", dataType = DataType.BOOLEAN_CHAR)
 

Thanks much to stew.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
BooleanCharType()

Method Summary

Modifier and Type	Method and Description
static BooleanCharType	getSingleton()
Object	javaToSqlArg(FieldType fieldType, Object obj) Convert a Java object and return the appropriate argument to a SQL insert or update statement.
Object	makeConfigObject(FieldType fieldType) This makes a configuration object for the data-type or returns null if none.
Object	parseDefaultString(FieldType fieldType, String defaultStr) Convert a default string object and return the appropriate argument to a SQL insert or update statement.
Object	resultStringToJava(FieldType fieldType, String stringValue, int columnPos) Convert a string result value to the related Java field.
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.BooleanType

isPrimitive

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

isAppropriateId, isEscapedValue

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

convertIdNumber, dataIsEqual, generateId, getAssociatedClasses, getAssociatedClassNames, getDefaultWidth, getPrimaryClass, getSqlOtherType, getSqlType, isArgumentHolderRequired, isComparable, isEscapedDefaultValue, isSelfGeneratedId, isValidForField, isValidForVersion, isValidGeneratedType, moveToNextValue

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

Constructor Detail

BooleanCharType

public BooleanCharType()

Method Detail

getSingleton

public static BooleanCharType 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.

Specified by:

parseDefaultString in interface FieldConverter

Overrides:

parseDefaultString in class BooleanObjectType

Returns:

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

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

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.

Specified by:

resultToSqlArg in interface FieldConverter

Overrides:

resultToSqlArg in class BooleanObjectType

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)

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.

resultStringToJava

public Object resultStringToJava(FieldType fieldType,
                                 String stringValue,
                                 int columnPos)

Description copied from interface: FieldConverter

Convert a string result value to the related Java field.

Specified by:

resultStringToJava in interface FieldConverter

Overrides:

resultStringToJava in class BaseDataType

makeConfigObject

public Object makeConfigObject(FieldType fieldType)
                        throws SQLException

Description copied from interface: DataPersister

This makes a configuration object for the data-type or returns null if none. The object can be accessed later via FieldType.getDataTypeConfigObj().

Specified by:

makeConfigObject in interface DataPersister

Overrides:

makeConfigObject in class BaseDataType

Throws:

SQLException - If there are problems creating the config object. Needed for subclasses.