KittyORM datatypes mapping

  

Demo application screenshots for this article

By design instead of mapping java types to SQLite supported SQL datatypes KittyORM maps them directly into SQLite affinities, KittyORM supports predefined mapping for primitive java types, primitive wrappers, byte array, enumerations and following types: java.lang.String, java.util.Date, java.util.Currency, java.util.Calendar, java.sql.Timestamp, java.math.BigInteger, java.math.BigDecimal, java.io.File, android.net.Uri.

TEXT datatype affinity mapping

INTEGER datatype affinity mapping

REAL datatype affinity mapping

NONE datatype affinity mapping

Custom mapping rules

By default, KittyORM provides mapping of most java types that you may want to use. However, KittyORM also offers some functionality for user defined mapping rules e.g. you can tell KittyORM how to store and retrieve any java objects you want. For those purposes KittyORM has KITTY_COLUMN_SERIALIZATION annotation with what you can achieve storing your objects or objects data as TEXT or NONE SQLite datatype affinities at your database. To use it, take following steps:

1. Define at KittyModel.class implementation model table field with SQLite datatype affinity specified explicitly (TypeAffinities.TEXT, TypeAffinities.BLOB or TypeAffinities.NONE only).

    1// Saving to text
    2@KITTY_COLUMN(
    3        columnOrder = 18,
    4        columnAffinity = TypeAffinities.TEXT
    5)
    6@KITTY_COLUMN_SERIALIZATION
    7public AnimalSounds stringSDF;
    8
    9// Saving to blob
   10@KITTY_COLUMN(
   11        columnOrder = 20,
   12        columnAffinity = TypeAffinities.BLOB
   13)
   14@KITTY_COLUMN_SERIALIZATION
   15public Bitmap byteArraySDF;

2. Write your methods how to transform your object to string\blob and back. If serializationMethodName or deserializationMethodName of KITTY_COLUMN_SERIALIZATION were not specified explicitly than KittyORM would try to call method String\byte[] "fieldname" + Serialize for serialization (no parameters) and YourType "fieldName" + Deserialize for deserialization (String\byte[] fromCursor as parameter). For example, for model field AnimalSounds stringSDF default serialization method would be String stringSDFSerialize() and default deserialization method would be AnimalSounds stringSDFDeserialize(String cvData).

    1String stringSDFSerialize() {
    2    if(stringSDF == null) return null;
    3    return new GsonBuilder().create().toJson(stringSDF);
    4}
    5
    6AnimalSounds stringSDFDeserialize(String cvData) {
    7    if(cvData == null) return null;
    8    if(cvData.length() == 0) return null;
    9    return new GsonBuilder().create().fromJson(cvData, AnimalSounds.class);
   10}
   11
   12public byte[] byteArraySDFSerialize() {//byteArraySDFSerialize
   13    if(byteArraySDF == null) return null;
   14    ByteArrayOutputStream bmpStream = new ByteArrayOutputStream();
   15    byteArraySDF.compress(Bitmap.CompressFormat.PNG, 100, bmpStream);
   16    return bmpStream.toByteArray();
   17}
   18
   19public Bitmap byteArraySDFDeserialize(byte[] cursorData) {
   20    if(cursorData == null) return null;
   21    if(cursorData.length == 0) return null;
   22    return BitmapFactory.decodeByteArray(cursorData, 0, cursorData.length);
   23}

Now you are ready for using custom mapping rules with KittyORM. Congratulations.