Schematic

Automatically generate a ContentProvider backed by an SQLite database.

Usage

First create a class that contains the columns of a database table.

public interface ListColumns {

  @DataType(INTEGER) @PrimaryKey @AutoIncrement String _ID = "_id";

  @DataType(TEXT) @NotNull String TITLE = "title";
}

Then create a database that uses this column

@Database(version = NotesDatabase.VERSION)
public final class NotesDatabase {

  public static final int VERSION = 1;

  @Table(ListColumns.class) public static final String LISTS = "lists";
}

And finally define a ContentProvider

@ContentProvider(authority = NotesProvider.AUTHORITY, database = NotesDatabase.class)
public final class NotesProvider {

  public static final String AUTHORITY = "net.simonvt.schematic.sample.NotesProvider";

  @TableEndpoint(table = NotesDatabase.LISTS) public static class Lists {

    @ContentUri(
        path = "lists",
        type = "vnd.android.cursor.dir/list",
        defaultSort = ListColumns.TITLE + " ASC")
    public static final Uri LISTS = Uri.parse("content://" + AUTHORITY + "/lists");
  }

Table column annotations

@AutoIncrement
@DataType
@DefaultValue
@NotNull
@PrimaryKey
@References
@Unique

Defining an Uri

The @ContentUri annotation is used when the Uri does not change.

@ContentUri(
  path = "lists",
  type = "vnd.android.cursor.dir/list",
  defaultSort = ListColumns.TITLE + " ASC")
public static final Uri LISTS = Uri.parse("content://" + AUTHORITY + "/lists");

If the Uri is created based on some value, e.g. an id, @InexactContentUri is used.

@InexactContentUri(
  path = Path.LISTS + "/#",
  name = "LIST_ID",
  type = "vnd.android.cursor.item/list",
  whereColumn = ListColumns._ID,
  pathSegment = 1)
public static Uri withId(long id) {
  return Uri.parse("content://" + AUTHORITY + "/lists/" + id);
}

Including in your project

dependencies {
  annotationProcessor 'net.simonvt.schematic:schematic-compiler:{latest-version}'
  compile 'net.simonvt.schematic:schematic:{latest-version}'
}

License