Fully documented all Kotlin files and added TODOs to functions that need to be updated in some way

2023-04-23 11:57:03 +02:00
parent 2534849329
commit fbad84aa09
33 changed files with 1220 additions and 571 deletions
@@ -0,0 +1,137 @@
+package com.denizk0461.studip.db
+
+import androidx.lifecycle.LiveData
+import androidx.room.Dao
+import androidx.room.Insert
+import androidx.room.Query
+import com.denizk0461.studip.model.*
+
+/**
+ * Database access object used for all database transactions in the app. Can be accessed through an
+ * instance of AppRepository.kt.
+ */
+@Dao
+interface AppDAO {
+
+    /* --- Stud.IP schedule events --- */
+
+    /**
+     * Retrieves all Stud.IP events.
+     *
+     * @return all Stud.IP events exposed through a LiveData object
+     */
+    @get:Query("SELECT * FROM events ORDER BY id")
+    val allEvents: LiveData<List<StudIPEvent>>
+
+    /**
+     * Inserts a Stud.IP event into the database.
+     *
+     * @param event object to be saved to the database
+     */
+    @Insert fun insert(event: StudIPEvent)
+
+    /**
+     * Inserts a list of Stud.IP events into the database.
+     *
+     * @param events objects to be saved to the database
+     */
+    @Insert fun insert(events: List<StudIPEvent>)
+
+    /**
+     * Deletes all Stud.IP events from the database.
+     */
+    @Query("DELETE FROM events")
+    fun nukeEvents()
+
+    /* --- canteen offers --- */
+
+    /**
+     * Retrieves all canteen offers. Objects will be joined through their primary/foreign keys from
+     * instances of OfferDate.kt, OfferCanteen.kt, OfferCategory.kt, and OfferItem.kt.
+     *
+     * @return all canteen offers exposed through a LiveData object
+     */
+    @get:Query(
+        "SELECT * FROM offer_item " +
+                "JOIN offer_category ON offer_item.categoryId = offer_category.id " +
+                "JOIN offer_canteen ON offer_category.canteenId = offer_canteen.id " +
+                "JOIN offer_date ON offer_category.dateId = offer_date.id"
+    )
+    val allOffers: LiveData<List<CanteenOffer>>
+
+    /**
+     * Retrieves all canteen offers that match given dietary preferences. Objects will be joined
+     * through their primary/foreign keys from instances of OfferDate.kt, OfferCanteen.kt,
+     * OfferCategory.kt, and OfferItem.kt.
+     *
+     * @return all canteen offers matching the given preference exposed through a LiveData object
+     */
+    @Query(
+        "SELECT * FROM offer_item " +
+                "JOIN offer_category ON offer_item.categoryId = offer_category.id " +
+                "JOIN offer_canteen ON offer_category.canteenId = offer_canteen.id " +
+                "JOIN offer_date ON offer_category.dateId = offer_date.id " +
+                "WHERE dietary_preferences = :prefs "
+    )
+    fun getOffersByPreference(prefs: String): LiveData<List<CanteenOffer>>
+
+    /**
+     * Retrieves all canteen offer date objects.
+     *
+     * @return a list of instances of canteen offer dates
+     */
+    @Query("SELECT * FROM offer_date ORDER BY id")
+    fun getDates(): List<OfferDate>
+
+    /**
+     * Deletes all dates from the database.
+     */
+    @Query("DELETE FROM offer_date")
+    fun nukeOfferDates()
+
+    /**
+     * Deletes all canteens from the database.
+     */
+    @Query("DELETE FROM offer_canteen")
+    fun nukeOfferCanteens()
+
+    /**
+     * Deletes all canteen offer categories from the database.
+     */
+    @Query("DELETE FROM offer_category")
+    fun nukeOfferCategories()
+
+    /**
+     * Deletes all canteen offer items from the database.
+     */
+    @Query("DELETE FROM offer_item")
+    fun nukeOfferItems()
+
+    /**
+     * Inserts a date into the database.
+     *
+     * @param date object to be saved to the database
+     */
+    @Insert fun insert(date: OfferDate)
+
+    /**
+     * Inserts a canteen into the database.
+     *
+     * @param canteen object to be saved to the database
+     */
+    @Insert fun insert(canteen: OfferCanteen)
+
+    /**
+     * Inserts a canteen offer category into the database.
+     *
+     * @param category object to be saved to the database
+     */
+    @Insert fun insert(category: OfferCategory)
+
+    /**
+     * Inserts a canteen offer item into the database.
+     *
+     * @param item object to be saved to the database
+     */
+    @Insert fun insert(item: OfferItem)
+}