OrmHelper

Android library for generating OrmLite Helper and ConfiUtil classes. This library generates classes during compile-time using Java Annotation Processor.

Helper classes provide:

• ORMLite DAO objects
• methods for creating, upgrading and clearing the all database tables

Usage

There are 3 annotations:

• @Helper
• @OnUpgrade
• @Path

@Helper

This annotation can be used to annotate a class. Annotated class will be then used to upgrade database if dropOnUpgrade is false and contains some @OnUpgrade method.

Mandatory fields:

• name = Database name.
• tables = List of classes representing database tables. Each class has to be annotated with [@DatabaseTable] (http://ormlite.com/javadoc/ormlite-core/com/j256/ormlite/table/DatabaseTable.html) (part of ORMLite library) and has to contain attribute annotated with [@DatabaseField] (http://ormlite.com/javadoc/ormlite-core/com/j256/ormlite/field/DatabaseField.html) (also part of ORMLite library) representing table id.

Optional fields:

• version (0 by default) = Database version.
• dropOnUpgrade (false by default) = If set to true, then all tables will be droped and recreated on database upgrade. (Useful for app development) Note: all @OnUpgrade methods will be ignored.
• withConfigUtil (false by default) = If set to true, then ConfigUtil class will be also generated. This class provides easy way to write ORMLite configuration file.

Example:

@Helper(
        name = "test",
        version = 3,
        tables = {
                Test.class,
                Question.class,
                Answer.class,
        },
        dropOnUpgrade = false,
        withConfigUtil = true
)
public class MyUpgrader {
}

@OnUpgrade

This annotation can be used to annotate methods inside class annotated with @Helper. Annotated method has to have 2 parameters - SQLiteDatabase and ConnectionSource.

• from = optional field. Number of database version from which database will be upgraded.
• to = mandatory field. Number of database version to which database will be upgraded.

Example:

    @OnUpgrade(from = 1, to = 2)
    public void upgrade1To2(SQLiteDatabase database, ConnectionSource connectionSource) {
        // do something in database
    }

@Path

This annotation can be used to annotate one static method inside class annotated with @Helper. Annotated method has to have 1 parameter - Context. In annotated method you can find/create directory on internal or external storage (For this reason you have parameter Context).

Example:

    @Path
    public static String getDbPath(Context context) {
        // find directory you want and build path for database file
        return "/custom/path/for/my/database.db"
    }

Download

Via Gradle:

compile 'eu.f3rog.ormlite:helper:1.0.0'
apt 'eu.f3rog.ormlite:helper-compiler:1.0.0'

Plus don't forget to include OrmLite library:

compile 'com.j256.ormlite:ormlite-android:4.48'

Or Maven:

<dependency>
  <groupId>eu.f3rog.ormlite</groupId>
  <artifactId>helper</artifactId>
  <version>1.0.0</version>
</dependency>
<dependency>
  <groupId>eu.f3rog.ormlite</groupId>
  <artifactId>helper-compiler</artifactId>
  <version>1.0.0</version>
  <optional>true</optional>
</dependency>