feat: add comments to code to repository part

Author: RoketFlame

lib/src/main/kotlin/repository/JsonRepository.kt

@@ -18,18 +18,20 @@ import trees.nodes.AbstractNode
 import java.io.File
 import java.io.FileNotFoundException
 
-
+//creates a new JsonRepository object with the given strategy and dirPath. strategy
 class JsonRepository<T : Comparable<T>,
         NodeType : AbstractNode<T, NodeType>,
         TreeType : AbstractTree<T, NodeType>>
     (
+    //serialization strategy for working with trees and nodes.
     strategy: Serialization<T, NodeType, TreeType, *>,
-    dirPath: String,
-    private val filename: String,
+    //path to the directory where tree files will be stored in JSON format.
+    dirPath: String
 ) : Repository<T, NodeType, TreeType>(strategy) {
 
     private val dirPath = "$dirPath/${strategy.typeOfTree.name.lowercase()}"
 
+    //function to convert JsonNode to SerializableNode.
     private fun JsonNode.toSerializableNode(): SerializableNode {
         return SerializableNode(
             data,
@@ -39,6 +41,7 @@ class JsonRepository<T : Comparable<T>,
         )
     }
 
+    //a function to deserialize a JsonNode into a tree node
     private fun JsonNode.deserialize(parent: NodeType? = null): NodeType? {
         val node = strategy.createNode(this.toSerializableNode())
         node?.parent = parent
@@ -47,6 +50,7 @@ class JsonRepository<T : Comparable<T>,
         return node
     }
 
+    //function to convert SerializableNode to JsonNode.
     private fun SerializableNode.toJsonNode(): JsonNode {
         return JsonNode(
             data,
@@ -56,6 +60,7 @@ class JsonRepository<T : Comparable<T>,
         )
     }
 
+    //function to convert SerializableTree to JsonTree
     private fun SerializableTree.toJsonTree(): JsonTree {
         return JsonTree(
             name,
@@ -64,14 +69,16 @@ class JsonRepository<T : Comparable<T>,
         )
     }
 
+    //method for getting a list of tree names.
     override fun getNames(): List<String> =
         File(dirPath).listFiles()?.map {
             Json.decodeFromString<JsonTree>(it.readText()).name
         } ?: listOf()
 
+    //method to load a tree by name
     override fun loadByName(name: String): TreeType? {
         val json = try {
-            File(dirPath, "${name.hashCode()}.json").readText()
+            File(dirPath, "${name}.json").readText()
         } catch (_: FileNotFoundException) {
             return null
         }
@@ -82,17 +89,19 @@ class JsonRepository<T : Comparable<T>,
         }
     }
 
+    //method to save tree by name
     override fun save(name: String, tree: TreeType) {
         val jsonTree = tree.toSerializableTree(name).toJsonTree()
 
         File(dirPath).mkdirs()
-        File(dirPath, filename).run {
+        File(dirPath, "${name}.json").run {
             createNewFile()
             writeText(Json.encodeToString(jsonTree))
         }
     }
 
+    //a method for deleting a tree by name
     override fun deleteByName(name: String) {
-        File(dirPath, "${name.hashCode()}.json").delete()
+        File(dirPath, "${name}.json").delete()
     }
 }

lib/src/main/kotlin/repository/Neo4jRepository.kt

@@ -27,6 +27,7 @@ class Neo4jRepo<T : Comparable<T>,
     private val sessionFactory = SessionFactory(configuration, "repository")
     private val session = sessionFactory.openSession()
 
+    //converts Neo4jNodeEntity to SerializableNode.
     private fun Neo4jNodeEntity.toSerializableNode(): SerializableNode {
         return SerializableNode(
             data,
@@ -36,6 +37,7 @@ class Neo4jRepo<T : Comparable<T>,
         )
     }
 
+    //converts Neo4jNodeEntity to a node
     private fun Neo4jNodeEntity.deserialize(parent: NodeType? = null): NodeType? {
         val node = strategy.createNode(this.toSerializableNode())
         node?.parent = parent
@@ -44,6 +46,7 @@ class Neo4jRepo<T : Comparable<T>,
         return node
     }
 
+    //converts SerializableTree to Neo4jTreeEntity.
     private fun SerializableNode.toEntity(): Neo4jNodeEntity {
         return Neo4jNodeEntity(
             data,
@@ -53,6 +56,7 @@ class Neo4jRepo<T : Comparable<T>,
         )
     }
 
+    //converts Neo4jTreeEntity to SerializableTree.
     private fun Neo4jTreeEntity.toTree(): SerializableTree {
         return SerializableTree(
             name,
@@ -69,12 +73,14 @@ class Neo4jRepo<T : Comparable<T>,
         )
     }
 
+    //saves the tree with the specified name to the database.
     override fun save(name: String, tree: TreeType) {
         deleteByName(name)
         val entityTree = tree.toSerializableTree(name).toEntity()
         session.save(entityTree)
     }
 
+    //is used to get a list of trees from the database that match the specified filtering options.
     private fun findByVerboseName(name: String) = session.loadAll(
         Neo4jTreeEntity::class.java,
         Filters().and(
@@ -85,6 +91,7 @@ class Neo4jRepo<T : Comparable<T>,
         -1
     )
 
+    //loads the tree with the specified name from the database.
     override fun loadByName(name: String): TreeType {
         val tree = findByVerboseName(name).singleOrNull()
         val result = strategy.createTree().apply {
@@ -93,6 +100,7 @@ class Neo4jRepo<T : Comparable<T>,
         return result
     }
 
+    //removes the tree with the specified name from the database.
     override fun deleteByName(name: String) {
         session.query(
             "MATCH toDelete=(" +
@@ -102,6 +110,7 @@ class Neo4jRepo<T : Comparable<T>,
         )
     }
 
+    //returns a list of the names of all saved trees in the database.
     override fun getNames(): List<String> = session.loadAll(
         Neo4jTreeEntity::class.java,
         Filter("typeOfTree", ComparisonOperator.EQUALS, strategy.typeOfTree),

lib/src/main/kotlin/repository/Repository.kt

@@ -16,6 +16,8 @@ abstract class Repository<T : Comparable<T>,
         TreeType : AbstractTree<T, NodeType>>(
     protected val strategy: Serialization<T, NodeType, TreeType, *>
 ) {
+    //An extension function that converts an instance of a NodeType to a serializable
+    //representation of a SerializableNode using the serialization strategy
     protected fun NodeType.toSerializableNode(): SerializableNode {
         return SerializableNode(
             strategy.serializeValue(this.data),
@@ -25,7 +27,9 @@ abstract class Repository<T : Comparable<T>,
         )
     }
 
-
+    //An extension function that converts a TreeType instance to a serializable
+    // representation of a SerializableTree using the serialization  strategy.
+    // The name of the tree is given by the name parameter
     protected fun TreeType.toSerializableTree(name: String): SerializableTree {
         return SerializableTree(
             name = name,
@@ -34,8 +38,17 @@ abstract class Repository<T : Comparable<T>,
         )
     }
 
+    //an abstract method that saves an instance of tree in the repository under the given name
     abstract fun save(name: String, tree: TreeType)
+
+    //abstract method that loads a tree instance from the repository given name.
+    // If no tree with the specified name is found, the method should return null.
     abstract fun loadByName(name: String): TreeType?
+
+    //an abstract method that removes a tree instance from the repository at the given name
     abstract fun deleteByName(name: String)
+
+    //abstract method that returns a list of the names of all trees stored in the repository.
+    // If there are no trees in the repository, the method should return an empty list
     abstract fun getNames(): List<String>
 }

lib/src/main/kotlin/repository/SQLRepository.kt

@@ -5,6 +5,10 @@
 
 package repository
 
+import NodesTable
+import SQLNodeEntity
+import SQLTreeEntity
+import TreesTable
 import org.jetbrains.exposed.sql.Database
 import org.jetbrains.exposed.sql.SchemaUtils
 import org.jetbrains.exposed.sql.SqlExpressionBuilder.eq
@@ -16,10 +20,6 @@ import repository.serialization.SerializableNode
 import repository.serialization.SerializableTree
 import repository.serialization.SerializableValue
 import repository.serialization.strategies.Serialization
-import repository.sqliteEntities.NodesTable
-import repository.sqliteEntities.SQLNodeEntity
-import repository.sqliteEntities.SQLTreeEntity
-import repository.sqliteEntities.TreesTable
 import trees.AbstractTree
 import trees.nodes.AbstractNode
 
@@ -32,13 +32,15 @@ class SQLRepository<T : Comparable<T>,
 
     private val typeOfTree = strategy.typeOfTree.toString()
 
+    //Initializes the database tables for storing trees and nodes.
     init {
         transaction(db) {
             SchemaUtils.create(TreesTable)
             SchemaUtils.create(NodesTable)
         }
     }
 
+    //Converts an instance of SQLNodeEntity to a SerializableNode object using the serialization strategy.
     private fun SQLNodeEntity.toSerializableNode(): SerializableNode {
         return SerializableNode(
             SerializableValue(data),
@@ -48,6 +50,7 @@ class SQLRepository<T : Comparable<T>,
         )
     }
 
+    //Deserializes an instance of SQLNodeEntity to a NodeType object using the serialization strategy.
     private fun SQLNodeEntity.deserialize(parent: NodeType? = null): NodeType? {
         val node = strategy.createNode(this.toSerializableNode())
         node?.parent = parent
@@ -56,6 +59,7 @@ class SQLRepository<T : Comparable<T>,
         return node
     }
 
+    //Converts a SerializableNode object to an instance of SQLNodeEntity using the serialization strategy.
     private fun SerializableNode.toEntity(tree: SQLTreeEntity): SQLNodeEntity = SQLNodeEntity.new {
         this@new.data = this@toEntity.data.value
         this@new.metadata = this@toEntity.metadata.value
@@ -64,20 +68,22 @@ class SQLRepository<T : Comparable<T>,
         this.tree = tree
     }
 
+    //Converts a SerializableTree object to an instance of SQLTreeEntity.
     private fun SerializableTree.toEntity(): SQLTreeEntity {
         return SQLTreeEntity.new {
             this.name = this@toEntity.name
             this.typeOfTree = this@SQLRepository.typeOfTree
         }
     }
 
+    //Saves a TreeType object to the database with a given name by deleting any existing tree with the same name and creating a new one.
     override fun save(name: String, tree: TreeType): Unit = transaction(db) {
         deleteByName(name)
         val entityTree = tree.toSerializableTree(name).toEntity()
         entityTree.root = tree.root?.toSerializableNode()?.toEntity(entityTree)
     }
 
-
+    //Loads a TreeType object from the database by name, if it exists.
     override fun loadByName(name: String): TreeType? = transaction(db) {
         SQLTreeEntity.find(
             TreesTable.typeOfTree eq typeOfTree and (TreesTable.name eq name)
@@ -86,6 +92,7 @@ class SQLRepository<T : Comparable<T>,
         }
     }
 
+    //Deletes a tree from the database by name.
     override fun deleteByName(name: String): Unit = transaction(db) {
         val treeId = SQLTreeEntity.find(
             TreesTable.typeOfTree eq strategy.typeOfTree.toString() and (TreesTable.name eq name)
@@ -98,6 +105,7 @@ class SQLRepository<T : Comparable<T>,
         }
     }
 
+    //Returns a list of names of all the trees in the database.
     override fun getNames(): List<String> = transaction(db) {
         SQLTreeEntity.find(TreesTable.typeOfTree eq typeOfTree).map(SQLTreeEntity::name)
     }

lib/src/main/kotlin/repository/jsonEntities/JsonNode.kt

@@ -9,11 +9,16 @@ import kotlinx.serialization.Serializable
 import repository.serialization.Metadata
 import repository.serialization.SerializableValue
 
-
+//A class that represents a tree node in JSON format. Contains
 @Serializable
 data class JsonNode(
+    //Node value in serializable format;
     val data: SerializableValue,
+    //Node metadata, including node height, balancing factor,
+    //and other information needed to work with the tree;
     val metadata: Metadata,
+    //Link to the left child node.
     val left: JsonNode?,
+    //Link to the right child node.
     val right: JsonNode?
 )

lib/src/main/kotlin/repository/jsonEntities/JsonTree.kt

@@ -5,13 +5,17 @@
 
 package repository.jsonEntities
 
-
 import kotlinx.serialization.Serializable
 import repository.serialization.TypeOfTree
 
+//Describes the "repository.jsonEntities.JsonTree" object - this is the tree
+// that will be serialized and stored in JSON format
 @Serializable
 data class JsonTree(
+    //a string that contains the name of the tree.
     val name: String,
+    //contains a tree type, which can be one of the "TypeOfTree" enums.
     val typeOfTree: TypeOfTree,
+    //This is a reference to the root node of the tree, which can either be a "repository.jsonEntities.JsonNode" object
     val root: JsonNode?
 )

lib/src/main/kotlin/repository/neo4jEntities/Neo4jNodeEntity.kt

@@ -11,18 +11,21 @@ import repository.serialization.SerializableValue
 
 @NodeEntity("Node")
 class Neo4jNodeEntity(
+
+    //serializable node value stored in the database as a string.
     @Property("data")
     var data: SerializableValue,
-
+    //node metadata stored in the database as a string.
     @Property("metadata")
     var metadata: Metadata,
-
+    //reference to the left child node in the tree structure.
     @Relationship(type = "LEFT", direction = Relationship.Direction.OUTGOING)
     var left: Neo4jNodeEntity? = null,
-
+    //reference to the right child node in the tree structure.
     @Relationship(type = "RIGHT", direction = Relationship.Direction.OUTGOING)
     var right: Neo4jNodeEntity? = null,
 ) {
+    //the node ID generated by the database on save.
     @Id
     @GeneratedValue
     var id: Long? = null

lib/src/main/kotlin/repository/neo4jEntities/Neo4jTreeEntity.kt

@@ -10,16 +10,17 @@ import repository.serialization.TypeOfTree
 
 @NodeEntity("Tree")
 class Neo4jTreeEntity(
+    //a class property that stores the name of the tree.
     @Property("name")
     var name: String,
-
+    //a class property that stores the tree type.
     @Property("typeOfTree")
     var typeOfTree: TypeOfTree,
-
+    //a class property that stores a reference to the root node of the tree.
     @Relationship(type = "ROOT", direction = Relationship.Direction.OUTGOING)
     var root: Neo4jNodeEntity?,
 ) {
-
+    //a class property that stores the tree ID in the Neo4j database.
     @Id
     @GeneratedValue
     var id: Long? = null

lib/src/main/kotlin/repository/serialization/strategies/AVLStrategy.kt

@@ -18,6 +18,7 @@ class AVLStrategy<T : Comparable<T>>(
 ) : Serialization<T, AVLNode<T>, AVLTree<T>, Int>(serializeData, deserializeData) {
     override val typeOfTree: TypeOfTree = TypeOfTree.AVL_TREE
 
+    //method that creates an AVL tree node from the passed SerializableNode, which was obtained as a result of serialization.
     override fun createNode(node: SerializableNode?): AVLNode<T>? = node?.let {
         AVLNode(
             data = deserializeValue(node.data),
@@ -27,9 +28,12 @@ class AVLStrategy<T : Comparable<T>>(
         )
     }
 
+    //method that deserializes the node's metadata (in this case, the node's height). Returns the deserialized metadata.
     override fun deserializeMetadata(metadata: Metadata) = metadata.value.toInt()
 
+    //method that serializes the node's metadata (in this case, the node's height). Returns the serialized metadata.
     override fun serializeMetadata(node: AVLNode<T>) = Metadata(node.height.toString())
 
+    //method that creates an AVL tree. Returns a new AVL tree of type AVLTree<T>.
     override fun createTree() = AVLTree<T>()
 }