triple nested binding

vincentlauvlwj · vincentlauvlwj · commit e9a80acc5cac · 2018-12-27T20:07:35.000+08:00
diff --git a/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityDml.kt b/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityDml.kt
@@ -61,6 +61,11 @@ private fun Table<*>.findInsertColumns(entity: Entity<*>): Map<Column<*>, Any?>
                 val child = entity[binding.property1.name] as Entity<*>?
                 child?.get(binding.property2.name)?.let { assignments[column] = it }
             }
+            is TripleNestedBinding -> {
+                val child = entity[binding.property1.name] as Entity<*>?
+                val grandChild = child?.get(binding.property2.name) as Entity<*>?
+                grandChild?.get(binding.property3.name)?.let { assignments[column] = it }
+            }
             is ReferenceBinding -> {
                 val child = entity[binding.onProperty.name] as Entity<*>?
                 child?.getPrimaryKeyValue(binding.referenceTable)?.let { assignments[column] = it }
@@ -116,12 +121,23 @@ private fun EntityImpl.findChangedColumns(fromTable: Table<*>): Map<Column<*>, A
             }
             is NestedBinding -> {
                 val child = this[binding.property1.name] as Entity<*>?
-                val childChanges = child?.impl?.changedProperties ?: kotlin.collections.emptySet<String>()
+                val childChanges = child?.impl?.changedProperties ?: emptySet<String>()
 
                 if (binding.property1.name in changedProperties || binding.property2.name in childChanges) {
                     assignments[column] = child?.get(binding.property2.name)
                 }
             }
+            is TripleNestedBinding -> {
+                val child = this[binding.property1.name] as Entity<*>?
+                val childChanges = child?.impl?.changedProperties ?: emptySet<String>()
+
+                val grandChild = child?.get(binding.property2.name) as Entity<*>?
+                val grandChildChanges = grandChild?.impl?.changedProperties ?: emptySet<String>()
+
+                if (binding.property1.name in changedProperties || binding.property2.name in childChanges || binding.property3.name in grandChildChanges) {
+                    assignments[column] = grandChild?.get(binding.property3.name)
+                }
+            }
             is ReferenceBinding -> {
                 if (binding.onProperty.name in changedProperties) {
                     val child = this[binding.onProperty.name] as Entity<*>?
diff --git a/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityExtensions.kt b/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityExtensions.kt
@@ -1,9 +1,6 @@
 package me.liuwj.ktorm.entity
 
-import me.liuwj.ktorm.schema.NestedBinding
-import me.liuwj.ktorm.schema.ReferenceBinding
-import me.liuwj.ktorm.schema.SimpleBinding
-import me.liuwj.ktorm.schema.Table
+import me.liuwj.ktorm.schema.*
 import kotlin.reflect.KClass
 
 internal fun Entity<*>.getPrimaryKeyValue(fromTable: Table<*>): Any? {
@@ -18,14 +15,19 @@ internal fun Entity<*>.getPrimaryKeyValue(fromTable: Table<*>): Any? {
             val child = this[binding.property1.name] as Entity<*>?
             return child?.get(binding.property2.name)
         }
+        is TripleNestedBinding -> {
+            val child = this[binding.property1.name] as Entity<*>?
+            val grandChild = child?.get(binding.property2.name) as Entity<*>?
+            return grandChild?.get(binding.property3.name)
+        }
         is ReferenceBinding -> {
             val child = this[binding.onProperty.name] as Entity<*>?
             return child?.getPrimaryKeyValue(binding.referenceTable)
         }
     }
 }
 
-internal fun Entity<*>.setPrimaryKeyValue(fromTable: Table<*>, value: Any?) {
+internal fun Entity<*>.setPrimaryKeyValue(fromTable: Table<*>, value: Any) {
     val primaryKey = fromTable.primaryKey ?: kotlin.error("Table ${fromTable.tableName} dosen't have a primary key.")
     val binding = primaryKey.binding ?: kotlin.error("Primary key $primaryKey has no bindings to any entity field.")
 
@@ -42,6 +44,21 @@ internal fun Entity<*>.setPrimaryKeyValue(fromTable: Table<*>, value: Any?) {
 
             child[binding.property2.name] = value
         }
+        is TripleNestedBinding -> {
+            var child = this[binding.property1.name] as Entity<*>?
+            if (child == null) {
+                child = Entity.create(binding.property1.returnType.classifier as KClass<*>, parent = this, fromTable = fromTable)
+                this[binding.property1.name] = child
+            }
+
+            var grandChild = child[binding.property2.name] as Entity<*>?
+            if (grandChild == null) {
+                grandChild = Entity.create(binding.property2.returnType.classifier as KClass<*>, parent = child, fromTable = fromTable)
+                child[binding.property2.name] = grandChild
+            }
+
+            grandChild[binding.property3.name] = value
+        }
         is ReferenceBinding -> {
             var child = this[binding.onProperty.name] as Entity<*>?
             if (child == null) {
diff --git a/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityFinding.kt b/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityFinding.kt
@@ -22,7 +22,7 @@ fun <E : Entity<E>, K : Any> Table<E>.findMapByIds(ids: Collection<K>): Map<K, E
 @Suppress("UNCHECKED_CAST")
 fun <E : Entity<E>> Table<E>.findListByIds(ids: Collection<Any>): List<E> {
     if (ids.isEmpty()) {
-        return kotlin.collections.emptyList()
+        return emptyList()
     } else {
         val primaryKey = (this.primaryKey as? Column<Any>) ?: kotlin.error("Table $tableName dosen't have a primary key.")
         return findList { primaryKey inList ids }
@@ -146,7 +146,24 @@ private fun QueryRowSet.retrieveColumn(column: Column<*>, intoEntity: Entity<*>)
                 }
 
                 child[binding.property2.name] = columnValue
-                child.discardChanges()
+            }
+        }
+        is TripleNestedBinding -> {
+            val columnValue = this[column]
+            if (columnValue != null) {
+                var child = intoEntity[binding.property1.name] as Entity<*>?
+                if (child == null) {
+                    child = Entity.create(binding.property1.returnType.classifier as KClass<*>, parent = intoEntity)
+                    intoEntity[binding.property1.name] = child
+                }
+
+                var grandChild = child[binding.property2.name] as Entity<*>?
+                if (grandChild == null) {
+                    grandChild = Entity.create(binding.property2.returnType.classifier as KClass<*>, parent = child)
+                    child[binding.property2.name] = grandChild
+                }
+
+                grandChild[binding.property3.name] = columnValue
             }
         }
         is ReferenceBinding -> {
diff --git a/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityImpl.kt b/ktorm-core/src/main/kotlin/me/liuwj/ktorm/entity/EntityImpl.kt
@@ -1,9 +1,6 @@
 package me.liuwj.ktorm.entity
 
-import me.liuwj.ktorm.schema.NestedBinding
-import me.liuwj.ktorm.schema.ReferenceBinding
-import me.liuwj.ktorm.schema.SimpleBinding
-import me.liuwj.ktorm.schema.Table
+import me.liuwj.ktorm.schema.*
 import org.slf4j.LoggerFactory
 import java.io.ObjectInputStream
 import java.io.ObjectOutputStream
@@ -193,11 +190,24 @@ class EntityImpl(
                 binding.property.name == name
             }
             is NestedBinding -> {
-                val p = parent
-                if (p == null) {
+                val parent = this.parent
+                if (parent == null) {
                     binding.property1.name == name
                 } else {
-                    p[binding.property1.name] == this && binding.property2.name == name
+                    parent[binding.property1.name] == this && binding.property2.name == name
+                }
+            }
+            is TripleNestedBinding -> {
+                val parent = this.parent
+                if (parent == null) {
+                    binding.property1.name == name
+                } else {
+                    val grandParent = parent.impl.parent
+                    if (grandParent == null) {
+                        parent[binding.property1.name] == this && binding.property2.name == name
+                    } else {
+                        grandParent[binding.property1.name] == parent && parent[binding.property2.name] == this && binding.property3.name == name
+                    }
                 }
             }
             is ReferenceBinding -> {
diff --git a/ktorm-core/src/main/kotlin/me/liuwj/ktorm/schema/Column.kt b/ktorm-core/src/main/kotlin/me/liuwj/ktorm/schema/Column.kt
@@ -14,20 +14,37 @@ sealed class ColumnBinding
 /**
  * 将列绑定到一个简单属性
  */
-data class SimpleBinding(val property: KProperty1<*, *>) : ColumnBinding()
+data class SimpleBinding(
+    val property: KProperty1<*, *>
+) : ColumnBinding()
 
 /**
  * 将列绑定到层级嵌套的属性，仅支持两级嵌套
  */
-data class NestedBinding(val property1: KProperty1<*, *>, val property2: KProperty1<*, *>) : ColumnBinding()
+data class NestedBinding(
+    val property1: KProperty1<*, *>,
+    val property2: KProperty1<*, *>
+) : ColumnBinding()
+
+/**
+ * Binding the column to triple nested properties
+ */
+data class TripleNestedBinding(
+    val property1: KProperty1<*, *>,
+    val property2: KProperty1<*, *>,
+    val property3: KProperty1<*, *>
+): ColumnBinding()
 
 /**
  * 将列绑定到一个引用表，对应 SQL 中的外键引用，在使用 find* 系列 Entity 扩展函数时，引用表会自动被 left join 联接
  *
  * @see me.liuwj.ktorm.entity.joinReferencesAndSelect
  * @see me.liuwj.ktorm.entity.createEntity
  */
-data class ReferenceBinding(val referenceTable: Table<*>, val onProperty: KProperty1<*, *>) : ColumnBinding()
+data class ReferenceBinding(
+    val referenceTable: Table<*>,
+    val onProperty: KProperty1<*, *>
+) : ColumnBinding()
 
 /**
  * 列声明
diff --git a/ktorm-core/src/main/kotlin/me/liuwj/ktorm/schema/Table.kt b/ktorm-core/src/main/kotlin/me/liuwj/ktorm/schema/Table.kt
@@ -169,10 +169,7 @@ open class Table<E : Entity<E>>(
          * @see me.liuwj.ktorm.entity.createEntity
          */
         fun <R : Entity<R>> references(referenceTable: Table<R>, onProperty: KProperty1<E, R?>): ColumnRegistration<C> {
-            if (!onProperty.isAbstract) {
-                throw IllegalArgumentException("Cannot bind a column to a non-abstract property: $onProperty")
-            }
-
+            checkAbstractProperties(onProperty)
             checkCircularReference(referenceTable)
             return doBinding(ReferenceBinding(copyReference(referenceTable), onProperty))
         }
@@ -201,27 +198,31 @@ open class Table<E : Entity<E>>(
          * 将列绑定到一个简单属性
          */
         fun bindTo(property: KProperty1<E, C?>): ColumnRegistration<C> {
-            if (!property.isAbstract) {
-                throw IllegalArgumentException("Cannot bind a column to a non-abstract property: $property")
-            }
-
+            checkAbstractProperties(property)
             return doBinding(SimpleBinding(property))
         }
 
         /**
          * 将列绑定到层级嵌套的属性，仅支持两级嵌套
          */
         fun <R : Entity<R>> bindTo(property1: KProperty1<E, R?>, property2: KProperty1<R, C?>): ColumnRegistration<C> {
-            if (!property1.isAbstract) {
-                throw IllegalArgumentException("Cannot bind a column to a non-abstract property: $property1")
-            }
-            if (!property2.isAbstract) {
-                throw IllegalArgumentException("Cannot bind a column to a non-abstract property: $property2")
-            }
-
+            checkAbstractProperties(property1, property2)
             return doBinding(NestedBinding(property1, property2))
         }
 
+        /**
+         * Binding the column to triple nested properties.
+         */
+        fun <R : Entity<R>, S : Entity<S>> bindTo(
+            property1: KProperty1<E, R?>,
+            property2: KProperty1<R, S?>,
+            property3: KProperty1<S, C?>
+        ): ColumnRegistration<C> {
+
+            checkAbstractProperties(property1, property2, property3)
+            return doBinding(TripleNestedBinding(property1, property2, property3))
+        }
+
         private fun doBinding(binding: ColumnBinding): ColumnRegistration<C> {
             val column = _columns[key] ?: throw NoSuchElementException(key)
 
@@ -232,6 +233,14 @@ open class Table<E : Entity<E>>(
 
             return this
         }
+
+        private fun checkAbstractProperties(vararg properties: KProperty1<*, *>) {
+            for (prop in properties) {
+                if (!prop.isAbstract) {
+                    throw IllegalArgumentException("Cannot bind a column to a non-abstract property: $prop")
+                }
+            }
+        }
     }
 
     /**
diff --git a/ktorm-core/src/test/kotlin/me/liuwj/ktorm/entity/EntityTest.kt b/ktorm-core/src/test/kotlin/me/liuwj/ktorm/entity/EntityTest.kt
@@ -206,21 +206,35 @@ class EntityTest : BaseTest() {
         assert(employees[2]!!.name == "marry")
     }
 
+    interface Parent : Entity<Parent> {
+        var child: Child
+    }
+
+    interface Child : Entity<Child> {
+        var grandChild: GrandChild
+    }
+
+    interface GrandChild : Entity<GrandChild> {
+        var id: Int
+    }
+
+    object Parents : Table<Parent>("t_employee") {
+        val id by int("id").primaryKey().bindTo(Parent::child, Child::grandChild, GrandChild::id)
+    }
+
     @Test
     fun testUpdatePrimaryKey() {
         try {
-            val table = object : Table<Employee>("t_employee") {
-                val id by int("id").primaryKey().bindTo(Employee::manager, Employee::id)
-            }
-
-            val employee = table.findById(1) ?: throw AssertionError()
-            assert(employee.manager!!.id == 1)
+            val parent = Parents.findById(1) ?: throw AssertionError()
+            assert(parent.getPrimaryKeyValue(Parents) == 1)
+            assert(parent.child.grandChild.id == 1)
 
-            employee.manager = Employee()
+            parent.child.grandChild.id = 2
             throw AssertionError()
 
         } catch (e: UnsupportedOperationException) {
             // expected
+            println(e.message)
         }
     }
 }
diff --git a/ktorm-support-mysql/src/main/kotlin/me/liuwj/ktorm/support/mysql/Functions.kt b/ktorm-support-mysql/src/main/kotlin/me/liuwj/ktorm/support/mysql/Functions.kt
@@ -10,11 +10,11 @@ fun <T : Any> Column<List<T>>.jsonContains(item: T, itemSqlType: SqlType<T>): Fu
     // json_contains(column, json_array(item))
     return FunctionExpression(
         functionName = "json_contains",
-        arguments = kotlin.collections.listOf(
+        arguments = listOf(
             asExpression(),
             FunctionExpression(
                 functionName = "json_array",
-                arguments = kotlin.collections.listOf(ArgumentExpression(item, itemSqlType)),
+                arguments = listOf(ArgumentExpression(item, itemSqlType)),
                 sqlType = listSqlType
             )
         ),
@@ -47,7 +47,7 @@ fun <T : Any> Column<*>.jsonExtract(path: String, sqlType: SqlType<T>): Function
     // json_extract(column, path)
     return FunctionExpression(
         functionName = "json_extract",
-        arguments = kotlin.collections.listOf(asExpression(), ArgumentExpression(path, VarcharSqlType)),
+        arguments = listOf(asExpression(), ArgumentExpression(path, VarcharSqlType)),
         sqlType = sqlType
     )
 }
