updated readme

README.md

@@ -0,0 +1,187 @@
+# EasiestSqlLibrary
+The Easiest and Laziest approach to Android SQL Database.
+
+## Installation
+
+
+
+## Basic Usage
+Steps to follow:
+1. Initialize
+2. Add Tables and Columns
+3. Call `doneAddingTables` method
+
+After that, you can do all kinds of CRUD ( Create, Read, Update, Delete ) operations.
+
+## Initialize the Database and the Tables
+###### EasiestDB.init(Context context)
+###### easiestDB.addTableColumns(String tableName, Column... columns)
+###### easiestDB.doneAddingTables()
+
+```
+EasiestDB easiestDB = EasiestDB.init(this)
+                    .addTableColumns("table 1",
+                            new Column("Column a1", "text"),
+                            new Column("Column a2", "text")
+                    )
+                    .addTableColumns("table 2",
+                            new Column("Column b1", "text"),
+                            new Column("Column b2", "text", "unique")
+                    )
+                    .doneAddingTables();
+```
+
+* You don't need to add the "ID" primary key column. ```EasiestSqlLibrary``` does that by default.
+
+## Add data
+###### easiestDB.addDataInTable(int tableIndex, Datum... data)
+###### Datum(String columnName, String value)
+###### Datum(String columnName, int value)
+###### Datum(String columnName, double value)
+###### Datum(int columnIndex, String value)
+###### Datum(int columnIndex, int value)
+###### Datum(int columnIndex, double value)
+
+```
+boolean added = easiestDB.addDataInTable(0,
+        new Datum(1, "Value1"),
+        new Datum(2, "Value2")
+);
+```
+
+## Get All data from a table
+###### easiestDB.getAllDataFrom(int tableIndex)
+###### easiestDB.getAllDataFrom(String tableName)
+
+```
+Cursor cursor = easiestDB.getAllDataFrom(0);
+if (cursor != null) {
+    while (cursor.moveToNext()) {
+        int value1 = cursor.getInt(columnIndex);
+        String value2 = cursor.getString(columnIndex);
+        double value3 = cursor.getDouble(columnIndex);
+    }
+}
+```
+or
+###### easiestDB.getAllDataOrderedBy(int columnIndex, boolean ascending, int tableIndex)
+
+```
+Cursor cursor = easiestDB.getAllDataOrderedBy(0, true, 0);
+if (cursor != null) {
+    while (cursor.moveToNext()) {
+        int value1 = cursor.getInt(columnIndex);
+        String value2 = cursor.getString(columnIndex);
+        double value3 = cursor.getDouble(columnIndex);
+    }
+}
+```
+
+## Get All data from a row within a table
+###### easiestDB.getOneRowData(int tableIndex, int rowNumber)
+###### easiestDB.getOneRowData(String tableName, int rowNumber)
+
+```
+Cursor cursor = easiestDB.getOneRowData(0, 0);
+if (cursor != null) {
+    cursor.moveToFirst();
+    int value1 = cursor.getInt(columnIndex);
+    String value2 = cursor.getString(columnIndex);
+    double value3 = cursor.getDouble(columnIndex);
+}
+```
+
+## Search value in a column within a table
+###### easiestDB.searchInOneColumn(int columnIndex, String valueToSearch, int limit, int tableIndex)
+###### easiestDB.searchInOneColumn(String columnName, String valueToSearch, int limit, int tableIndex)
+
+```
+Cursor cursor = easiestDB.searchInOneColumn(1, "Value1", 0, 0);
+if (cursor != null) {
+    cursor.moveToFirst();
+    int value1 = cursor.getInt(columnIndex);
+    String value2 = cursor.getString(columnIndex);
+    double value3 = cursor.getDouble(columnIndex);
+}
+```
+
+## Match values in multiple columns. ( Example: Matching ID and password for a user within a table )
+###### easiestDB.searchValuesInMultipleColumns(int tableIndex, Datum... data)
+
+```
+Cursor cursor = easiestDB.searchValuesInMultipleColumns(1,
+        new Datum(1, "Value1"),
+        new Datum(2, "Value2")
+);
+boolean matched = cursor.getCount() > 0;
+```
+
+## Update data in a row
+###### easiestDB.updateData(int tableIndex, int rowNumber, Datum... data)
+
+```
+boolean updated = easiestDB.updateData(0, 1,
+        new Datum(1, "Value1.1"),
+        new Datum(2, "Value2.2")
+);
+```
+
+## Delete one row
+###### easiestDB.deleteRow(int tableIndex, int rowNumber)
+
+```
+boolean deleted = easiestDB.deleteRow(0, 1);
+```
+
+## Delete a row if values match in a column
+###### easiestDB.deleteRowIfValuesMatchIn(int tableIndex, Datum data)
+###### easiestDB.deleteRowIfValuesMatchIn(int tableIndex, Datum data)
+
+```
+boolean deleted = easiestDB.deleteRowIfValuesMatchIn(0,
+        new Datum(1, "Value1")
+);
+```
+
+## Delete all data from a table
+###### easiestDB.deleteAllDataFrom(String tableName)
+###### easiestDB.deleteAllDataFrom(int tableIndex)
+
+```
+easiestDB.deleteAllDataFrom(0)
+```
+
+## Delete the all data from the database
+###### easiestDB.deleteDatabase()
+
+```
+boolean deleted = easiestDB.deleteDatabase();
+```
+
+I hope, you will enjoy using the library. Feel free to contribute codes.
+
+#### License
+
+```
+MIT License
+
+Copyright (c) 2020 Fayaz Bin Salam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

app/src/main/java/org/richit/easiestsqlandroidapp/MainActivity.java

@@ -2,8 +2,6 @@
 
 import android.database.Cursor;
 import android.os.Bundle;
-import android.util.Log;
-import android.widget.Toast;
 
 import androidx.appcompat.app.AppCompatActivity;
 
@@ -22,6 +20,7 @@ protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
+        // Init
         easiestDB = EasiestDB.init(this)
                 .addTableColumns("table 1",
                         new Column("Column a1", "text"),
@@ -32,5 +31,27 @@ protected void onCreate(Bundle savedInstanceState) {
                         new Column("Column b2", "text", "unique")
                 )
                 .doneAddingTables();
+
+        // Add
+        boolean added = easiestDB.addDataInTable(0,
+                new Datum(1, "Value1"),
+                new Datum(2, "Value2")
+        );
+
+        // Get all
+        Cursor cursor = easiestDB.getAllDataFrom(0);
+        if (cursor != null) {
+            while (cursor.moveToNext()) {
+//                int value1 = cursor.getInt(columnNumber);
+//                String value2 = cursor.getString(columnNumber);
+//                double value3 = cursor.getDouble(columnNumber);
+
+                String id = cursor.getString(0);
+
+            }
+        }
+
+        boolean deleted = easiestDB.deleteDatabase();
+
     }
 }

easiestsqllib/src/main/java/org/richit/easiestsqllib/Datum.java

@@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 public class Datum {
     private String columnName = "", value = "";
-    private int columnNumber;
+    private int columnIndex;
 
     public Datum(String columnName, String value) {
         this.columnName = columnName.replace(" ", "_").toUpperCase();
@@ -43,18 +43,18 @@ public Datum(String columnName, double value) {
         this.value = String.valueOf(value);
     }
 
-    public Datum(int columnNumber, String value) {
-        this.columnNumber = columnNumber;
+    public Datum(int columnIndex, String value) {
+        this.columnIndex = columnIndex;
         this.value = value;
     }
 
-    public Datum(int columnNumber, int value) {
-        this.columnNumber = columnNumber;
+    public Datum(int columnIndex, int value) {
+        this.columnIndex = columnIndex;
         this.value = String.valueOf(value);
     }
 
-    public Datum(int columnNumber, double value) {
-        this.columnNumber = columnNumber;
+    public Datum(int columnIndex, double value) {
+        this.columnIndex = columnIndex;
         this.value = String.valueOf(value);
     }
 
@@ -74,11 +74,11 @@ public void setValue(String value) {
         this.value = value;
     }
 
-    public int getColumnNumber() {
-        return columnNumber;
+    public int getColumnIndex() {
+        return columnIndex;
     }
 
-    public void setColumnNumber(int columnNumber) {
-        this.columnNumber = columnNumber;
+    public void setColumnIndex(int columnIndex) {
+        this.columnIndex = columnIndex;
     }
 }