Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SimonVT/schematic
Automatically generate ContentProviders
https://github.com/SimonVT/schematic
Last synced: 3 months ago
JSON representation
Automatically generate ContentProviders
- Host: GitHub
- URL: https://github.com/SimonVT/schematic
- Owner: SimonVT
- Created: 2014-05-04T16:46:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-02-14T17:22:43.000Z (over 5 years ago)
- Last Synced: 2024-06-28T11:32:51.001Z (5 months ago)
- Language: Java
- Size: 537 KB
- Stars: 1,336
- Watchers: 50
- Forks: 136
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Schematic
=========
Automatically generate a ContentProvider backed by an SQLite database.
Usage
=====
First create a class that contains the columns of a database table.
```java
public interface ListColumns {
@DataType(INTEGER) @PrimaryKey @AutoIncrement String _ID = "_id";
@DataType(TEXT) @NotNull String TITLE = "title";
}
```
Then create a database that uses this column
```java
@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
```java
@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
------------------------
```java
@AutoIncrement
@DataType
@DefaultValue
@NotNull
@PrimaryKey
@References
@Unique
```
Defining an Uri
---------------
The ```@ContentUri``` annotation is used when the ```Uri``` does not change.
```java
@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.
```java
@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
=========================
```groovy
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.