See ORMLite and ORMLite : Android Supports , ORMLite : Using With Android.
See Android Developers : Content Provider
This is a library that easy to make using ContentProvider with OrmLite.
With this library, you can focus on the operation of the table.
You can from among the following three of the abstract class, select the inheritance class.
android.content.ContentProvider
└ OrmLiteBaseContentProvider
└ OrmLiteDefaultContentProvider
└ OrmLiteSimpleContentProvider
Can be used to match the level of your implementation.
About the OrmLiteSimpleContentProvider easiest, I will introduce the procedure.
Download from ORMLite : OrmLite Releases
- ormlite-core-4.45.jar
- ormlite-android-4.45.jar
- ormlite-jdbc-4.45.jar(If you need)
Add these to your project.
See stackoverflow : How to import a jar in Eclipse?
git clone git@github.com:jakenjarvis/Android-OrmLiteContentProvider.git <Anywhere>
Add the LibraryProject to your project.
See Android Developers : Referencing a library project
See Android Developers : Implementing a Contract Class
You define the column name as a string. You are free to define it.
public class Contract
{
public static final String DATABASE_NAME = "MyDatabase";
public static final int DATABASE_VERSION = 1;
public static final String AUTHORITY = "com.tojc.ormlite.android.ormlitecontentprovidersample";
// accounts table info
public static class Account implements BaseColumns
{
public static final String TABLENAME = "accounts";
public static final String CONTENT_URI_PATH = TABLENAME;
public static final String MIMETYPE_TYPE = TABLENAME;
public static final String MIMETYPE_NAME = AUTHORITY + ".provider";
// feild info
public static final String NAME = "name";
// content uri pattern code
public static final int CONTENT_URI_PATTERN_MANY = 1;
public static final int CONTENT_URI_PATTERN_ONE = 2;
// Refer to activity.
public static final Uri contentUri = new Uri.Builder()
.scheme(ContentResolver.SCHEME_CONTENT)
.authority(AUTHORITY)
.appendPath(CONTENT_URI_PATH)
.build();
}
}
See ORMLite documents : Configuring a Class
You can use the annotations added by OrmLiteContentProvider library.
- @DefaultContentUri
- @DefaultContentMimeTypeVnd
- @DefaultSortOrder
- @ProjectionMap
For added annotations, see the javadoc.
@DatabaseTable(tableName = Contract.Account.TABLENAME)
@DefaultContentUri(authority=Contract.AUTHORITY, path=Contract.Account.CONTENT_URI_PATH)
@DefaultContentMimeTypeVnd(name=Contract.Account.MIMETYPE_NAME, type=Contract.Account.MIMETYPE_TYPE)
public class Account
{
@DatabaseField(columnName = Contract.Account._ID, generatedId = true)
@DefaultSortOrder
private int id;
@DatabaseField
private String name;
public Account()
{
// ORMLite needs a no-arg constructor
}
public Account(String name)
{
this.id = 0;
this.name = name;
}
public int getId()
{
return id;
}
public String getName()
{
return name;
}
}
See ORMLite : OrmLiteSqliteOpenHelper
and Android Developers : SQLiteOpenHelper.
Implementing the OrmLiteSqliteOpenHelper class is required. How to implement OrmLiteSqliteOpenHelper, please refer to manual of ORMLite.
public class SampleHelper extends OrmLiteSqliteOpenHelper
{
public SampleHelper(Context context)
{
super(context,
Contract.DATABASE_NAME,
null,
Contract.DATABASE_VERSION
);
}
@Override
public void onCreate(SQLiteDatabase database, ConnectionSource connectionSource)
{
try
{
TableUtils.createTableIfNotExists(connectionSource, Account.class);
}
catch(SQLException e)
{
e.printStackTrace();
}
}
@Override
public void onUpgrade(SQLiteDatabase database, ConnectionSource connectionSource, int oldVersion, int newVersion)
{
try
{
TableUtils.dropTable(connectionSource, Account.class, true);
TableUtils.createTable(connectionSource, Account.class);
}
catch(SQLException e)
{
e.printStackTrace();
}
}
}
See Android Developers : Implementing the ContentProvider Class
Implement an abstract class OrmLiteSimpleContentProvider.
public class MyProvider extends OrmLiteSimpleContentProvider<OrmLiteSqliteSampleHelper>
{
@Override
protected Class<OrmLiteSqliteSampleHelper> getHelperClass()
{
return OrmLiteSqliteSampleHelper.class;
}
@Override
public boolean onCreate()
{
Controller = new MatcherController()
.add(Account.class, SubType.Directory, "", Contract.Account.CONTENT_URI_PATTERN_MANY)
.add(Account.class, SubType.Item, "#", Contract.Account.CONTENT_URI_PATTERN_ONE)
.initialize();
return true;
}
}
By getHelperClass() method to register the Helper class. To register for a pattern in onCreate(). Creates an instance of MatcherController To do so, call add() method. After registering all patterns, please call the initialize() method.
This is more flexible precisely because the user can set MatcherController arbitrarily. This is the most important key points of the Android-OrmLiteContentProvider library.
// Undefined @DefaultContentUri and @DefaultContentMimeTypeVnd annotations.
// This can be defined using MatcherController.
@DatabaseTable(tableName = Contract.NewTable.TABLENAME)
public class NewTable
{
@DatabaseField(columnName = Contract.NewTable._ID, generatedId = true)
private int key;
@DatabaseField
private String name;
public NewTable()
{
// ORMLite needs a no-arg constructor
}
// etc..
}
public class MyProvider extends OrmLiteSimpleContentProvider<OrmLiteSqliteSampleHelper>
{
@Override
protected Class<OrmLiteSqliteSampleHelper> getHelperClass()
{
return OrmLiteSqliteSampleHelper.class;
}
@Override
public boolean onCreate()
{
Controller = new MatcherController()
.add(Account.class)
.add(SubType.Directory, "", Contract.Account.CONTENT_URI_PATTERN_MANY)
.add(SubType.Item, "#", Contract.Account.CONTENT_URI_PATTERN_ONE)
// Add new table. You can add more than one table.
// Is considered to be set to the table(class) that you have added to end.
.add(NewTable.class)
// Defined DefaultContentUri and DefaultContentMimeTypeVnd.
.setDefaultContentUri(
Contract.AUTHORITY,
Contract.NewTable.CONTENT_URI_PATH)
.setDefaultContentMimeTypeVnd(
Contract.NewTable.MIMETYPE_NAME,
Contract.NewTable.MIMETYPE_TYPE)
// (NewTable.class)
.add(SubType.Directory, "", Contract.NewTable.CONTENT_URI_PATTERN_MANY)
.add(SubType.Item, "#", Contract.NewTable.CONTENT_URI_PATTERN_ONE)
// add other pattern. 'content://com.example.app.provider/newtable/dataset'
.add(SubType.Directory, "dataset", Contract.NewTable.CONTENT_URI_PATTERN_DATASET)
.initialize();
return true;
}
}
See Android Developers : The <provider> Element.
Add AndroidManifest.xml
<provider android:name=".provider.MyProvider"
android:authorities="com.tojc.ormlite.android.ormlitecontentprovidersample"
android:exported="false"/>
See Android Developers : Content Provider Basics.
Run the test program.
public class MainActivity extends Activity
{
@Override
protected void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ContentValues values = new ContentValues();
values.clear();
values.put(Contract.Account.NAME, "Yamada Tarou");
getContentResolver().insert(Contract.Account.contentUri, values);
Cursor c = getContentResolver().query(Contract.Account.contentUri, null, null, null, null);
while(c.moveToNext())
{
for (int i = 0; i < c.getColumnCount(); i++)
{
Log.d(getClass().getSimpleName(), c.getColumnName(i) + " : " + c.getString(i));
}
}
c.close();
}
}
This document is part of the Android-OrmLiteContentProvider project.
Copyright (c) 2012, Jaken Jarvis (jaken.jarvis@gmail.com)
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
The author may be contacted via https://github.com/jakenjarvis/Android-OrmLiteContentProvider