refactored bookmarks and added locators

r2-shared/r2-shared.iml

@@ -154,15 +154,19 @@
       <sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/rs" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/shaders" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/annotations" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/attr" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/check-manifest" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/classes" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/extractedTypedefs" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/intermediate-jars" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/javaPrecompile" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/jniLibs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/library_and_local_jars_jni" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/manifests" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/packaged-aidl" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/packaged-classes" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/packagedAssets" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/packaged_res" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/public_res" />

r2-shared/src/main/java/org/readium/r2/shared/Contributor.kt

@@ -24,7 +24,7 @@ class Contributor : JSONable, Serializable {
     var name: String? = null
         get() = multilanguageName.singleString
 
-    override fun getJSON(): JSONObject {
+    override fun toJSON(): JSONObject {
         val obj = JSONObject()
         obj.put("name", name)
         if (roles.isNotEmpty()) {

r2-shared/src/main/java/org/readium/r2/shared/JSONable.kt

@@ -13,6 +13,6 @@ import org.json.JSONObject
 
 interface JSONable {
 
-    fun getJSON(): JSONObject
+    fun toJSON(): JSONObject
 
 }

r2-shared/src/main/java/org/readium/r2/shared/Link.kt

@@ -48,7 +48,7 @@ class Link : JSONable, Serializable {
         return properties.encryption != null
     }
 
-    override fun getJSON(): JSONObject {
+    override fun toJSON(): JSONObject {
         val json = JSONObject()
         json.putOpt("title", title)
         json.putOpt("type", typeLink)

r2-shared/src/main/java/org/readium/r2/shared/Locator.kt

@@ -0,0 +1,186 @@
+/*
+ * Module: r2-shared-kotlin
+ * Developers: Aferdita Muriqi, Mostapha Idoubihi, Paul Stoica
+ *
+ * Copyright (c) 2018. Readium Foundation. All rights reserved.
+ * Use of this source code is governed by a BSD-style license which is detailed in the
+ * LICENSE file present in the project repository where this source code is maintained.
+ */
+
+package org.readium.r2.shared
+
+import org.joda.time.DateTime
+import org.json.JSONObject
+
+
+
+/**
+ * Locator model
+ *
+ * @var bookId: Long? - Book index in the database
+ * @val publicationID: String -  Publication identifier
+ * @val resourceIndex: Long - Index to the spine element of the book
+ * @val resourceHref: String -  Reference to the spine element
+ * @val resourceTitle: String - Title to the spine element of the book
+ * @val location: Location - Location in the spine element
+ * @val creationDate: Long - Datetime when the bookmark has been created
+ * @var id: Long? - ID of the bookmark in database
+ *
+ * @fun toString(): String - Return a String description of the Locator
+ */
+
+
+open class Locator(val href:String,
+              val created:Long,
+              val title:String,
+              val locations:Locations,
+              val text:LocatorText?) {}
+
+class LocatorText(var after:String? = null,
+                  var before:String? = null,
+                  var hightlight:String? = null)
+    : JSONable {
+
+        companion object {
+            fun fromJSON(json: JSONObject): LocatorText {
+
+                val location = LocatorText()
+                if (json.has("before")) {
+                    location.before = json.getString("before")
+                }
+                if (json.has("hightlight")) {
+                    location.hightlight = json.getString("hightlight")
+                }
+                if (json.has("after")) {
+                    location.after = json.getString("after")
+                }
+
+                return location
+            }
+        }
+
+        override fun toJSON(): JSONObject {
+            val json = JSONObject()
+
+            before?.let {
+                json.putOpt("before", before)
+            }
+            hightlight?.let {
+                json.putOpt("hightlight", hightlight)
+            }
+            after?.let {
+                json.putOpt("after", after)
+            }
+
+            return json
+        }
+
+        override fun toString(): String {
+            var jsonString = """{"""
+
+            if (before != null) {
+                before.let { jsonString += """ "before": "$before" ,""" }
+            }
+            if (hightlight != null) {
+                hightlight.let { jsonString += """ "before": "$hightlight" ,""" }
+            }
+            if (after != null) {
+                after.let { jsonString += """ "after": "$after" ,""" }
+            }
+            jsonString += """}"""
+            return jsonString
+        }
+}
+
+
+/**
+ * Location : Class that contain the different variables needed to localize a particular position
+ *
+ * @var id: Long? - Identifier of a specific fragment in the publication
+ * @var cfi: String? - String formatted to designed a particular place in an Publication
+ * @var cssSelector: String? - Css selector
+ * @var xpath: String? - An xpath in the resource
+ * @var progression: Double - A percentage ( between 0 and 1 ) of the progression in a Publication
+ * @var position: Long - Index of a segment in the resource / synthetic page number!!??
+ *
+ */
+class Locations(var id: Long? = null,
+               var cfi: String? = null,             // 1 = highlight, annotation etc  = priority 3
+               var cssSelector: String? = null,     // 2 =
+               var xpath: String? = null,           // 2 =
+               var progression: Double? = null,     // 3 = bookmark         = priority 1 (done)
+               var position: Long? = null           // 4 = got page         = priority 2
+) : JSONable {
+
+    companion object {
+        fun fromJSON(json: JSONObject): Locations {
+
+            val location = Locations()
+            if (json.has("id")) {
+                location.id = json.getLong("id")
+            }
+            if (json.has("cfi")) {
+                location.cfi = json.getString("cfi")
+            }
+            if (json.has("cssSelector")) {
+                location.cssSelector = json.getString("cssSelector")
+            }
+            if (json.has("xpath")) {
+                location.xpath = json.getString("xpath")
+            }
+            if (json.has("progression")) {
+                location.progression = json.getDouble("progression")
+            }
+            if (json.has("position")) {
+                location.position = json.getLong("position")
+            }
+
+            return location
+        }
+    }
+
+    override fun toJSON(): JSONObject {
+        val json = JSONObject()
+
+        id?.let {
+            json.putOpt("id", id)
+        }
+        cfi?.let {
+            json.putOpt("cfi", cfi)
+        }
+        cssSelector?.let {
+            json.putOpt("cssSelector", cssSelector)
+        }
+        xpath?.let {
+            json.putOpt("xpath", xpath)
+        }
+        progression?.let {
+            json.putOpt("progression", progression)
+        }
+        position?.let {
+            json.putOpt("position", position)
+        }
+
+        return json
+    }
+
+    override fun toString(): String {
+        var jsonString = """{"""
+        if (id != null) {
+            id.let { jsonString += """ "id": "$id" ,""" }
+        }
+        if (cfi != null) {
+            cfi.let { jsonString += """ "cfi": "$cfi" ,""" }
+        }
+        if (cssSelector != null) {
+            cssSelector.let { jsonString += """ "cssSelector": "$cssSelector" ,""" }
+        }
+        if (xpath != null) {
+            xpath.let { jsonString += """ "xpath": "$xpath" ,""" }
+        }
+        progression.let { jsonString += """ "progression": "$progression" ,""" }
+        position.let { jsonString += """ "position": "$position" """ }
+        jsonString += """}"""
+        return jsonString
+    }
+}

r2-shared/src/main/java/org/readium/r2/shared/Properties.kt

@@ -42,7 +42,7 @@ class Properties : JSONable, Serializable {
     ///
     var indirectAcquisition: MutableList<IndirectAcquisition> = mutableListOf()
 
-    override fun getJSON(): JSONObject {
+    override fun toJSON(): JSONObject {
         val json = JSONObject()
         if (contains.isNotEmpty()) json.put("contains", getStringArray(contains))
         json.putOpt("mediaOverlay", mediaOverlay)

r2-shared/src/main/java/org/readium/r2/shared/Publication.kt

@@ -26,7 +26,7 @@ fun URL.removeLastComponent(): URL {
 fun getJSONArray(list: List<JSONable>): JSONArray {
     val array = JSONArray()
     for (i in list) {
-        array.put(i.getJSON())
+        array.put(i.toJSON())
     }
     return array
 }
@@ -46,15 +46,15 @@ fun tryPut(obj: JSONObject, list: List<JSONable>, tag: String) {
 
 // Try to put class which implements JSONable only if not empty
 fun tryPut(jsonObject: JSONObject, jsonable: JSONable, tag: String) {
-    val tempJsonObject = jsonable.getJSON()
+    val tempJsonObject = jsonable.toJSON()
     if (tempJsonObject.length() != 0)
         jsonObject.put(tag, tempJsonObject)
 }
 
 class TocElement(val link: Link, val children: List<TocElement>) : JSONable {
 
-    override fun getJSON(): JSONObject {
-        val json = link.getJSON()
+    override fun toJSON(): JSONObject {
+        val json = link.toJSON()
         tryPut(json, children, "children")
         return json
     }

r2-shared/src/main/java/org/readium/r2/shared/Subject.kt

@@ -22,7 +22,7 @@ class Subject : JSONable, Serializable {
     //  Epub 3.1 "code" (opf:term)
     var code: String? = null
 
-    override fun getJSON(): JSONObject {
+    override fun toJSON(): JSONObject {
         val json = JSONObject()
         json.putOpt("name", name)
         json.putOpt("sortAs", sortAs)

r2-shared/src/test/java/org/readium/r2/LocatorsUnitTest.kt

@@ -0,0 +1,36 @@
+/*
+ * Module: r2-shared-kotlin
+ * Developers: Aferdita Muriqi, Mostapha Idoubihi, Paul Stoica
+ *
+ * Copyright (c) 2018. Readium Foundation. All rights reserved.
+ * Use of this source code is governed by a BSD-style license which is detailed in the
+ * LICENSE file present in the project repository where this source code is maintained.
+ */
+
+package org.readium.r2
+
+import java.net.URI
+
+/*
+class LocatorsUnitTest {
+
+    lateinit var locatorList: MutableList<Locator>
+
+    init {
+        locatorList.add(Locator("FirstPublication", 1, null, URI("FirstPublication"), Location("FirstPublication", null, null, 0.0f, 0)))
+        locatorList.add(Locator("FirstPublication", 1, null, URI("FirstPublication"), Location("FirstPublication", null, null, 0.0f, 0)))
+        locatorList.add(Locator("SecondPublication", 2, null, URI("SecondPublication"), Location("SecondPublication", null, null, 0.23931f, 3)))
+        locatorList.add(Locator("SixthPublication", 6, null, URI("SixthPublication"), Location("SixthPublication", null, null, 0.5f, 6)))
+        locatorList.add(Locator("ThirteenthPublication", 13, null, URI("ThirteenthPublication"), Location("ThirteenthPublication", null, null, 0.1578f, 13)))
+        locatorList.add(Locator("IsThatEvenAPub?!", -2, null, URI("IsThatEvenAPub?!"), Location("IsThatEvenAPub?!", null, null, 0.9239f, -2)))
+        locatorList.add(Locator("ComeOn..", 8, null, URI("ComeOn.."), Location("ComeOn..", null, null, -0.323f, 8)))
+    }
+
+    fun addToList(newElem: Locator){
+        locatorList.add(newElem)
+    }
+
+    fun test(){
+
+    }
+}*/