Freezer


Source link: https://github.com/florent37/Freezer

Freezer

A simple & fluent Android ORM, how can it be easier ? And it's compatible with RxJava2 !

UserEntityManager userEntityManager = new UserEntityManager();
  userEntityManager.add(new User("Florent", 6));
 userEntityManager.add(new User("Florian", 3));
 userEntityManager.add(new User("Bastien", 3));
  List<User> allUsers = userEntityManager.select()

.name().startsWith("Flo")

.asList();
  userEntityManager.select()

  .age().equals(3)

  .asObservable()

.subscribeOn(Schedulers.newThread())

  .observeOn(AndroidSchedulers.mainThread())

  .subscribe(users ->

  //display the users

  );

First, initialize !

Don't forget to initialise Freezer in your application:

public class MyApplication extends Application {

@Override public void onCreate() {

super.onCreate();

Freezer.onCreate(this);

  
}
  
}

Second, annotate your models

Use Annotations to mark classes to be persisted:

@Model public class User {

  int age;
  String name;
  Cat cat;
  List<Cat> pets; 
}
@Model public class Cat {

  @Id long id;
  String name; 
}

Now, play with the managers !

Persist datas

Persist your data easily:

UserEntityManager userEntityManager = new UserEntityManager();
  User user = ... // Create a new object userEntityManager.add(user);

Querying

Freezer query engine uses a fluent interface to construct multi-clause queries.

Simple

To find all users:

List<User> allUsers = userEntityManager.select()

.asList();

To find the first user who is 3 years old:

User user3 = userEntityManager.select()

.age().equalsTo(3)

.first();

Complex

To find all users

  • with name "Florent"
  • or who own a pet with named "Java"

you would write:

List<User> allUsers = userEntityManager.select()

.name().equalsTo("Florent")

.or()

.cat(CatEntityManager.where().name().equalsTo("Java"))

.or()

.pets(CatEntityManager.where().name().equalsTo("Sasha"))

.asList();

Selectors

//strings

.name().equalsTo("florent")

.name().notEqualsTo("kevin")

.name().contains("flo")

.name().in("flo","alex","logan") //numbers

.age().equalsTo(10)

.age().notEqualsTo(30)

.age().greatherThan(5)

.age().between(10,20)

.age().in(10,13,16) //booleans

.hacker().equalsTo(true)

.hacker().isTrue()

.hacker().isFalse() //dates

.myDate().equalsTo(OTHER_DATE)

.myDate().notEqualsTo(OTHER_DATE)

.myDate().before(OTHER_DATE)

.myDate().after(OTHER_DATE)

Aggregation

The QueryBuilder offers various aggregation methods:

float agesSum

= userEntityManager.select().sum(UserColumns.age);
 float agesAverage  = userEntityManager.select().average(UserColumns.age);
 float ageMin

 = userEntityManager.select().min(UserColumns.age);
 float ageMax

 = userEntityManager.select().max(UserColumns.age);
 int count

 = userEntityManager.select().count();

Limit

The QueryBuilder offers a limitation method, for example, getting 10 users, starting from the 5th:

List<User> someUsers = userEntityManager.select()

.limit(5, 10) //start, count

.asList();

Asynchronous

Freezer offers various asynchronous methods:

Add / Delete / Update

userEntityManager

  .addAsync(users)

  .async(new SimpleCallback<List<User>>() {

@Override

public void onSuccess(List<User> data) {

 
}

  
}
);

Querying

userEntityManager

  .select()

  ...

  .async(new SimpleCallback<List<User>>() {

@Override

public void onSuccess(List<User> data) {

 
}

  
}
);

Observables

With RxJava

userEntityManager

  .select()

  ...

  .asObservable()

  ... //rx operations

  .subscribe(new Action1<List<User>>() {

@Override

public void call(List<User> users) {

}

  
}
);

Entities

Freezer makes it possible, yes you can design your entities as your wish:

@Model public class MyEntity {

// primitives
  [ int / float / boolean / String / long / double ] field;

 //dates
  Date myDate;

// arrays
  [ int[] / float[] / boolean[] / String[] / long[] / double ] array;

  // collections
  [ List<Integer> / List<Float> / List<Boolean> / List<String> / List<Long> / List<Double> ] collection;

 // One To One
  MySecondEntity child;

 // One To Many
  List<MySecondEntity> childs; 
}

Update

You can update a model:

user.setName("laurent");
 userEntityManager.update(user);

Id

You can optionnaly set a field as an identifier:

@Model public class MyEntity {

  @Id long id; 
}

The identifier must be a long

Ignore

You can ignore a field:

@Model public class MyEntity {

  @Ignore
  int field;
  
}

Logging

You can log all SQL queries from entities managers:

userEntityManager.logQueries((query, datas) -> Log.d(TAG, query) 
}

Migration

To handle schema migration, just add @Migration(newVersion) in a static method, then describe the modifications:

public class DatabaseMigration {

@Migration(2)
  public static void migrateTo2(Migrator migrator) {

migrator.update("User")

  .removeField("age")

  .renameTo("Man");

  
}

@Migration(3)
  public static void migrateTo3(Migrator migrator) {

migrator.update("Man")

  .addField("birth", ColumnType.Primitive.Int);

  
}

 @Migration(4)
  public static void migrateTo4(Migrator migrator) {

migrator.addTable(migrator.createModel("Woman")

  .field("name", ColumnType.Primitive.String)

  .build());

  
}
 
}

Migration isn't yet capable of:

  • changing type of field
  • adding/modifying One To One
  • adding/modifying One To Many
  • handling collections/arrays

Download

buildscript {

dependencies {

  classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

}
 
}
  apply plugin: 'com.neenbedankt.android-apt'  dependencies {

compile 'fr.xebia.android.freezer:freezer:2.0.6'
provided 'fr.xebia.android.freezer:freezer-annotations:2.0.6'
apt 'fr.xebia.android.freezer:freezer-compiler:2.0.6' 
}

Changelog

1.0.1

Introduced Migration Engine.

1.0.2

  • Support long & double
  • Support arrays
  • Improved QueryBuilder
  • Refactored cursors helpers

1.0.3

  • Support dates
  • Added unit tests
  • Fixed one to many

1.0.4

  • Added @Id & @Ignore

1.0.5

  • Model update

2.0.0

  • Async API
  • Support Observables
  • Added @DatabaseName

2.0.1

  • Limit

2.0.2

  • Added query.in(...values...)

2.0.3

  • Freezer.onCreate is no longer dynamic

2.0.5

  • Improved performace for batch add & update (thanks to graphee-gabriel)

2.0.6

  • Add or update object if same @Id onadd, addAll`

2.1.0

  • Added RxJava2 support

A project initiated by Xebia

This project was first developed by Xebia and has been open-sourced since. We will continue working on it. We encourage the community to contribute to the project by opening tickets and/or pull requests.

License

Copyright 2015 Xebia, Inc.  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. 

Resources

Qart merges picture and QR code.

Convert audio files inside your Android app easily. Supported formats: WAV, AAC, MP3, M4A, WMA and FLAC.

Customizable, sensor-enabled, door sign custom views for Android.

Android Dialogs on steroids.

Android Promise wrappers for Apache Http client.

A simple custom view based on EditText that lets you validate credit card numbers.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes