Android TV Launcher Pushed to Google Play

Over the past decade, the tech universe has seen two drastic and widely contrasting changes with … more

Cyngn, OnePlus, Micromax – The Legal Battle

Recently, a battle has been waging in India over the rights to distribute the commercial … more

Lean Mean Battery Power Saving App Review

We talk a lot about battery topics here at XDA TV. We talk about everything from Power Banks to USB … more

Android 5.1 Possibly Coming February 2015

Google released Android 5.0 just over a month ago, and since then Lollipop has been trying to … more

Welcome to XDA

Search to go directly to your device's forum

Register an account

Unlock full posting privileges

Ask a question

No registration required
Post Reply

DataManagement Library for Easy Android Database Storage

OP PunchInThroat

24th December 2012, 04:10 AM   |  #1  
OP Junior Member
Thanks Meter: 18
 
12 posts
Join Date:Joined: Dec 2012
Storing objects to a Database for an Android application should be fast and easy as:
Code:
dm.add(new StorableClass());
DataManagement is a new open source library that allows you to do just that.

DataManagement is a Java Android library designed to help easily and efficiently store aggregate classes to an SQLite database. It eliminates the need to write separate classes to manage database – object interactions and allows developers to use simple methods to store, query, update, and delete objects. The library is capable of storing all objects of classes whose instance variables are either primitive data types or are themselves objects of another storable class. The DataManagement Library condenses many standard database features into several simple methods. It is fully open source and the code can be found at http://epsilonlabsllc.github.com/DataManagement

Examples:
Creating a Storable Class:

Code:
public class StorableClass{
    @Id
    private int ident;
    private int num1;
    private double num2;
    private String num3;
    private boolean num4;
    public static final int num5 = 3;
    private OtherStorableClass[] ds2;
}
A storable class must meet two requirements. First, the class must have a private instance variable of type int that will be used as the id number of the object. This variable may be read by the application, but the application should not have the capability to write to or change this variable in anyway. This variable is identified by the system with an @Id annotation. In addition, the class should not have any instance variables that are not either primitive types, strings, or other storable objects.

Instantiating a DataManager Object:

Code:
DataManager dm = new DataManager(context);
The open method accepts the calling Context that is going to use the database. Usually this should be the calling Activity.

Opening a Database for Use:

Code:
dm.open();
This method must be called before the database is used in any way.

Closing a Database After Use:

Code:
dm.close();
This method should be called after all database operations have been performed.

Adding an Object to the Database:

Code:
int id = dm.add(new StorableClass());
The add method accepts an object of a storable class as its only parameter and adds it to the database. It returns its id in the database for future use.

Retrieving a Specific Item from the Database by ID:

Code:
StorableClass storableObject = dm.get(StorableClass.class, id);
The get method accepts two parameters: the data type of the stored object and the Id number of the object (the return value of the add method).

Retrieving All Objects of a Given Type Stored in the Database as a Collection:

Code:
storableObjectCollection = dm.getAll(StorableClass.class);
The getAll method’s only parameter is the class of the objects that should be retrieved.

Retrieving a Collection of Storable Objects that match a given criteria:

Code:
Collection<StorableClass> storableObjectCollection = dm.find(StorableClass.class, 5, "num1");
The find method accepts three parameters: the data type of the stored object, the value that is being searched for, and the name of the instance variable as a string. This method is overloaded in such a way that the second parameter may be any primitive value or a string.

Updating an Object in the Database:

Code:
dm.update(id, updatedObject);
The update method accepts two parameters: The id number of the object being updated and the updated object that will replace the existing one I the database. If the id number of the new object and the id number given as the first parameter do not match, the object’s id will be overwritten.

Deleting an Object by its Id number:

Code:
dm.delete(StorableClass.class, id);
The delete method accepts two parameters: The data type and id number of the object to be deleted.

Additional Notes:
Id numbers are used by the database to ensure that objects are put in the correct place and to allow the program to access these objects. It is important that programs using this library do not attempt to set these variables as they will be initialized and managed by the library. These id numbers are unique for objects of a given type; objects of different types may have the same id number. In addition, if objects are deleted from the database their id numbers are left empty and are not reused.

Licensing:
DataManagement is Currently Licensed under the GNU General Public License, version 3 (GPL-3.0). It is intended for open source use by anyone who would like to use it.
Last edited by PunchInThroat; 10th January 2013 at 04:19 AM.
The Following 17 Users Say Thank You to PunchInThroat For This Useful Post: [ View ]
27th December 2012, 03:02 AM   |  #2  
Member
Thanks Meter: 57
 
83 posts
Join Date:Joined: Mar 2011
More
This is awesome!!

Tried it out for an app today-- incredibly simple! For those looking-- this library essentially replaces loads of SQL helper classes and queries with an interface that's similar to ArrayList.

Definitely going to use this for everything in the future!

Thanks
10th January 2013, 01:58 AM   |  #3  
regaw_leinad's Avatar
Recognized Contributor / Recognized Developer
Flag Seattle, WA
Thanks Meter: 3,665
 
3,665 posts
Join Date:Joined: Jan 2010
More
Did you change the license or something? The repo is no longer on github.
10th January 2013, 03:30 AM   |  #4  
Member
Flag Boulder
Thanks Meter: 4
 
33 posts
Join Date:Joined: Jun 2011
Donate to Me
Quote:
Originally Posted by regaw_leinad

Did you change the license or something? The repo is no longer on github.

After a quick search on github, it looks like it's been moved here

https://github.com/epsilonlabsllc/DataManagement
10th January 2013, 04:13 AM   |  #5  
OP Junior Member
Thanks Meter: 18
 
12 posts
Join Date:Joined: Dec 2012
Quote:
Originally Posted by cmike21

After a quick search on github, it looks like it's been moved here

https://github.com/epsilonlabsllc/DataManagement


Thanks. I forgot to change it. I just edited my post with the correct url.
The Following User Says Thank You to PunchInThroat For This Useful Post: [ View ]
10th January 2013, 08:37 AM   |  #6  
Junior Member
Thanks Meter: 6
 
23 posts
Join Date:Joined: Dec 2010
More
Sounds awesome! Great work.

Gonna try it this evening.
10th January 2013, 10:56 AM   |  #7  
Junior Member
Thanks Meter: 0
 
10 posts
Join Date:Joined: Jan 2011
Anyone compared the performance with db4o?
10th January 2013, 11:11 AM   |  #8  
Junior Member
Flag Utrecht
Thanks Meter: 0
 
2 posts
Join Date:Joined: Sep 2008
More
are there any performance test with other DB libraries for android? and what about the this lib vs contentproviders?

activeandroid.com
code.google.com/p/orm-droid]orm-droid
satyan.github.com/sugar/
Last edited by aegis123; 10th January 2013 at 11:21 AM.
10th January 2013, 10:37 PM   |  #9  
azoller1's Avatar
Senior Member
Flag Lenexa
Thanks Meter: 1,666
 
1,777 posts
Join Date:Joined: Aug 2011
Donate to Me
More
will definitly be using this once i learn some app development! thanks for this!
11th January 2013, 07:31 AM   |  #10  
Junior Member
Flag Fort Wayne, Indiana
Thanks Meter: 2
 
18 posts
Join Date:Joined: May 2011
Donate to Me
More
Just in time...

Post Reply Subscribe to Thread

Tags
android, database, library
Previous Thread Next Thread
Thread Tools Search this Thread
Search this Thread:

Advanced Search
Display Modes