Initial commit

Author: frostybee

.gitignore

@@ -0,0 +1,28 @@
+# NetBeans specific #
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.nb-gradle/
+nbactions.xml
+nb-configuration.xml
+
+## Gradle specific
+.gradle
+gradle
+gradle/wrapper
+
+# Class Files #
+*.class
+
+# Package Files #
+*.jar
+*.war
+*.ear
+
+  
+#windows Junk
+*.ini
+[Tt]humbs.db
+*.DS_Store

README.md

@@ -0,0 +1,6 @@
+# An MVC-Based SQLite Client
+This is a simple MVC-based SQLite client written in Java. It uses the [Chinook](https://www.sqlitetutorial.net/sqlite-sample-database/) database and the [SQLite JDBC driver](https://github.com/xerial/sqlite-jdbc) that was designed and implmented by xerial (Taro L. Saito).
+
+
+
+

build.gradle

@@ -0,0 +1,20 @@
+apply plugin: 'java'
+apply plugin: 'jacoco'
+apply plugin: 'application'
+
+
+description = 'Working with JDBC and SQLite DB'
+group = 'org.bee'
+
+mainClassName = 'org.bee.sqlite.DriverMVC'
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    testImplementation     'junit:junit:4.13'
+    implementation 'org.xerial:sqlite-jdbc:3.32.3.2'
+}
+
+

data/chinook_sqlite.db

@@ -0,0 +1,7 @@
+# Generally it is better to set the version only for release builds, build time
+# from command line using -Pversion=1.0
+#
+# Only use SNAPSHOT versions if you need to contribute your binaries to a
+# local Maven project.
+version=1.0
+

gradle.properties

@@ -0,0 +1 @@
+rootProject.name = 'SQLiteDbSample'

settings.gradle

@@ -0,0 +1,37 @@
+package org.bee.sqlite;
+
+import org.bee.sqlite.controllers.CustomerController;
+import org.bee.sqlite.models.Customer;
+
+import java.util.List;
+
+/**
+ * A class for testing interactions with SQLite database.
+ *
+ * This sample demonstrates querying an SQLite database using SQLite JDBC
+ * driver. As data source, the Chinook database is used in this example.
+ *
+ * @see {@link https://www.sqlitetutorial.net/sqlite-sample-database/}
+ * @see {@link https://github.com/lerocha/chinook-database}
+ * @see {@link https://github.com/xerial/sqlite-jdbc}
+ *
+ * @author Sleiman R.
+ */
+public class DriverMVC {
+
+    public static void main(String[] args) {
+        CustomerController custController = new CustomerController();
+        //-- Retrieve th list of customers. 
+        List<Customer> customers = custController.getCustomersList();
+        printListOfCustomers(customers);
+    }
+
+    private static void printListOfCustomers(List<Customer> customers) {
+        System.out.println("===========================");
+        System.out.printf("Total customers found: %d \n", customers.size());
+        System.out.println("===========================");
+        for (Customer customer : customers) {
+            System.out.println(customer);
+        }
+    }
+}

src/main/java/org/bee/sqlite/DriverMVC.java

@@ -0,0 +1,78 @@
+package org.bee.sqlite.controllers;
+
+import org.bee.sqlite.helpers.DBConnectionProvider;
+import org.bee.sqlite.models.Customer;
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A class that handles database operations.
+ * @author Sleiman R.
+ */
+public class CustomerController {
+
+    private final String DATABASE_FILE_NAME = "chinook_sqlite.db";
+    private final String CUST_TABLE_NAME = "Customer";
+    //-- Column names
+    private final String CUSTOMER_ID = "CustomerId";
+    private final String FIRSTNAME = "FirstName";
+    private final String LASTNAME = "LastName";
+    private final String COMPANY = "Company";
+    private final String ADDRESS = "Address";
+    private final String CITY = "City";
+    private final String STATE = "State";
+    private final String COUNTRY = "Country";
+    private final String POSTALCODE = "PostalCode";
+    private final String PHONE = "Phone";
+    private final String FAX = "Fax";
+    private final String EMAIL = "Email";
+    private final String SUPPORTREP_ID = "SupportRepId";
+
+    
+    /**
+     * Retrieves a list of customers stored in an SQLite database table.
+     *
+     * @see
+     * {@link https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html}
+     * @return the retrieved list of customers.
+     */
+    public List<Customer> getCustomersList() {
+        List<Customer> customers = new ArrayList<>();
+        String query = "";
+        //-- Step 1 & 2) Open a connection to the specified database 
+        //--         and create a prepared statement for executing SQL queries.                  
+        try ( Connection dbConnection = DBConnectionProvider.getInstance().getConnection(DATABASE_FILE_NAME);  Statement stmt = dbConnection.createStatement()) {
+            query = String.format("SELECT * FROM %s ", CUST_TABLE_NAME);
+            try ( ResultSet resSet = stmt.executeQuery(query)) {
+                //--  Step 3) Process the list of records that are stored in the result set (in memory records).
+                while (resSet.next()) {
+                    //-- Retreive values from the current record.
+                    Customer customer = new Customer();
+                    customer.setCustomerId(resSet.getInt(CUSTOMER_ID));
+                    customer.setFirstName(resSet.getString(FIRSTNAME));
+                    customer.setLastName(resSet.getString(LASTNAME));
+                    customer.setCompany(resSet.getString(COMPANY));
+                    customer.setCountry(resSet.getString(COUNTRY));
+                    customer.setPostalCode(resSet.getString(POSTALCODE));
+                    customer.setPhone(resSet.getString(PHONE));
+                    customer.setAddress(resSet.getString(ADDRESS));
+                    customer.setCity(resSet.getString(CITY));
+                    customer.setState(resSet.getString(STATE));
+                    customer.setFax(resSet.getString(FAX));
+                    customer.setEmail(resSet.getString(EMAIL));
+                    customer.setSupporterId(resSet.getInt(SUPPORTREP_ID));
+                    //-- Step 4) Add the retrieved customer from the result set to the list.
+                    customers.add(customer);
+                }
+            }
+        } catch (SQLException ex) {
+            System.err.println("An error has occured while trying to execute the following query: " + query);
+            System.err.println("Error message: " + ex);
+        }
+        return customers;
+    }
+}

src/main/java/org/bee/sqlite/controllers/CustomerController.java

@@ -0,0 +1,46 @@
+package org.bee.sqlite.helpers;
+
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.SQLException;
+
+/**
+ * A singleton class that manages an SQLite connection.
+ *
+ * @author Sleiman R.
+ */
+public class DBConnectionProvider {
+
+    private static final String DB_FOLDER = "data";
+    private static DBConnectionProvider instance;
+
+    private DBConnectionProvider() {
+
+    }
+
+    /**
+     * Opens a connection to an SQLite database.
+     *
+     * @param databaseName the name of the SQLite database file (it can also be
+     * a relative path.
+     * @return a connection to an SQLite database.
+     */
+    public Connection getConnection(String databaseName) {
+        try {
+            String connectionString = String.format("jdbc:sqlite:%s/%s", DB_FOLDER, databaseName);
+            Class.forName("org.sqlite.JDBC");
+            Connection dbConnection = DriverManager.getConnection(connectionString);
+            return dbConnection;
+        } catch (ClassNotFoundException | SQLException e) {
+            System.out.println(e);
+            return null;
+        }
+    }
+
+    public static DBConnectionProvider getInstance() {
+        if (instance == null) {
+            instance = new DBConnectionProvider();
+        }
+        return instance;
+    }
+}

src/main/java/org/bee/sqlite/helpers/DBConnectionProvider.java

@@ -0,0 +1,136 @@
+package org.bee.sqlite.models;
+
+/**
+ * A class that represents a Customer record stored in the Chinook DB.
+ *
+ * @author Sleiman R.
+ */
+public class Customer {
+
+    private int CustomerId;
+    private String firstName;
+    private String lastName;
+    private String company;
+    private String address;
+    private String city;
+    private String state;
+    private String country;
+    private String postalCode;
+    private String phone;
+    private String fax;
+    private String email;
+    private int supporterId;
+
+    public Customer() {
+    }
+
+    public int getCustomerId() {
+        return CustomerId;
+    }
+
+    public void setCustomerId(int CustomerId) {
+        this.CustomerId = CustomerId;
+    }
+
+    public String getFirstName() {
+        return firstName;
+    }
+
+    public void setFirstName(String firstName) {
+        this.firstName = firstName;
+    }
+
+    public String getLastName() {
+        return lastName;
+    }
+
+    public void setLastName(String lastName) {
+        this.lastName = lastName;
+    }
+
+    public String getCompany() {
+        return company;
+    }
+
+    public void setCompany(String company) {
+        this.company = company;
+    }
+
+    public String getAddress() {
+        return address;
+    }
+
+    public void setAddress(String address) {
+        this.address = address;
+    }
+
+    public String getCity() {
+        return city;
+    }
+
+    public void setCity(String city) {
+        this.city = city;
+    }
+
+    public String getState() {
+        return state;
+    }
+
+    public void setState(String state) {
+        this.state = state;
+    }
+
+    public String getCountry() {
+        return country;
+    }
+
+    public void setCountry(String country) {
+        this.country = country;
+    }
+
+    public String getPostalCode() {
+        return postalCode;
+    }
+
+    public void setPostalCode(String postalCode) {
+        this.postalCode = postalCode;
+    }
+
+    public String getPhone() {
+        return phone;
+    }
+
+    public void setPhone(String phone) {
+        this.phone = phone;
+    }
+
+    public String getFax() {
+        return fax;
+    }
+
+    public void setFax(String fax) {
+        this.fax = fax;
+    }
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
+
+    public int getSupporterId() {
+        return supporterId;
+    }
+
+    public void setSupporterId(int supporterId) {
+        this.supporterId = supporterId;
+    }
+
+    @Override
+    public String toString() {
+        return "Customer{" + "CustomerId=" + CustomerId + ", firstName=" + firstName + ", lastName=" + lastName + ", company=" + company + ", address=" + address + ", city=" + city + ", state=" + state + ", country=" + country + ", postalCode=" + postalCode + ", phone=" + phone + ", fax=" + fax + ", email=" + email + '}';
+    }
+
+}