Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 2.74 KB

README.md

File metadata and controls

31 lines (26 loc) · 2.74 KB
Raw

EasyRoom

EasyRoom lets you have a simple and easy integration of Room Database into your Android app.

For a complete walkthrough, read this blog post.

Room provides an abstraction layer over SQLite to allow fluent database access while harnessing the full power of SQLite. Read all about it here.

What does EasyRoom offer?

This module offers an introductory integration of Room database into your app. Sample components of Room have been provided for your ease of building your first project with Room. Just download this module and import it into your android project to get started!

Start Using EasyRoom in these 3 simple steps:

  1. Download this module and extract the zip file in your preferred location.
  2. Import module by : File -> New -> Import Module, and then select the downloaded easyroom module from your download location.
  3. Make sure, you have the module implementation in your app level gradle file: Like this: screen

Components

A Room database has these components:

  • Entity class - The model class for your database table. This module gives you one already prepared in the entity folder! You can edit any SQL column you want in the table too!
  • DAO interface - Data Access Object for executing SQL Queries by Room. The DAO interface is included in the dao folder in the module. Customize it as you like!
  • Database Abstract Class - This module has one too!
  • Repository class - This is the class that is used to define the methods to be used in your activity to execute queries through the DAO object. EasyRoom has one included for basic CRUD operations (Insert, Update, Delete, Query)!

Other Utility Classes included for your convenience:

  • A TimeStamp Converter class- One of the useful feature of Room is Type Converters. When you have to store in database some custom types, you can use Type Converters. It converts from a unknown type into a known type in terms of database types.

    • Through this class, the type Date is stored as a String type into the database. It is located in the Utilities folder of the module.
    • You can see 2 defined methods:
      • toDate: converts a String value into a Date type
      • toString: converts a Date value into a String type

  • Time Class - This class is also in the Utilities folder of the module.

    • It has a method getFormattedDateString that lets you get a date in your preferred format.
    • Also, get the current date and time to store in the database directly from the getCurrentDateTime method.