Skip to content

SimonVT/schematic

Repository files navigation

Schematic

Automatically generate a ContentProvider backed by an SQLite database.

Usage

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

publicinterfaceListColumns{@DataType(INTEGER) @PrimaryKey@AutoIncrementString_ID = "_id"; @DataType(TEXT) @NotNullStringTITLE = "title"}

Then create a database that uses this column

@Database(version = NotesDatabase.VERSION) publicfinalclassNotesDatabase{publicstaticfinalintVERSION = 1; @Table(ListColumns.class) publicstaticfinalStringLISTS = "lists"}

And finally define a ContentProvider

@ContentProvider(authority = NotesProvider.AUTHORITY, database = NotesDatabase.class) publicfinalclassNotesProvider{publicstaticfinalStringAUTHORITY = "net.simonvt.schematic.sample.NotesProvider"; @TableEndpoint(table = NotesDatabase.LISTS) publicstaticclassLists{@ContentUri( path = "lists", type = "vnd.android.cursor.dir/list", defaultSort = ListColumns.TITLE + " ASC") publicstaticfinalUriLISTS = 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") publicstaticfinalUriLISTS = 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) publicstaticUriwithId(longid){returnUri.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

Copyright 2014 Simon Vig Therkildsen Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 

About

Automatically generate ContentProviders

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5