Finalize the README and LICENSE files

Author: Chamal-Peiris

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2022] Chamal Peiris. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,42 @@
+# Simple Text Edior Application
+
+
+
+
+**  With this basic ORM framework, you can create tables in the database without the use of any SQL queries**
+
+
+### How to use this repo?
+
+1. Clone the repository first  'git clone'
+
+``https://github.com/Chamal-Peiris/basic-orm-framework.git``
+
+2. Once cloned, open the repository from any prefered IDE
+
+3. Use Maven as the build tool
+
+4. Refresh the pom.xml
+
+
+### Prerequisites
+1. Use JDK 1.8
+
+
+
+## Usage
+
+* You can easily use the framework to create tables,databases without any SQL queries
+
+
+### License
+
+Version 1.0.0 ,30 May 2022
+
+Copyright © 2022 Chamal Peiris. All rights reserved.
+
+Licensed under the [MIT](LICENSE) license
+
+## Acknowledgements
+
+* [Choose an Open Source License](https://choosealicense.com)

…8/orm/annotations/DepSessionFactory.java …/lk/ijse/dep8/orm/DepSessionFactory.javasrc/main/java/lk/ijse/dep8/orm/annotations/DepSessionFactory.java renamed to src/main/java/lk/ijse/dep8/orm/DepSessionFactory.java src/main/java/lk/ijse/dep8/orm/annotations/DepSessionFactory.java renamed to src/main/java/lk/ijse/dep8/orm/DepSessionFactory.java

@@ -1,4 +1,7 @@
-package lk.ijse.dep8.orm.annotations;
+package lk.ijse.dep8.orm;
+
+import lk.ijse.dep8.orm.annotations.Entity;
+import lk.ijse.dep8.orm.annotations.Id;
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Field;
@@ -8,31 +11,60 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * DepSessionfactory is the starting porn of the ORM
+ *
+ * @author chamal-peiris
+ * @since 1.0.0
+ */
+
 
 public class DepSessionFactory {
     private final List<Class<?>> entityClassList = new ArrayList<>();
     private Connection connection;
 
+    /**
+     *Add classes that have benn annotated with <code>@Entity</code> annotation
+     * @param entityClass
+     * @return DepSessionFactory
+     * @throws RuntimeException if the class is not annotated with <code>@Entity</code> annotation
+     */
+
     public DepSessionFactory addAnnotatedClass(Class<?> entityClass){
         if (entityClass.getDeclaredAnnotation(Entity.class) == null){
             throw new RuntimeException("Invalid entity class");
         }
         entityClassList.add(entityClass);
         return this;
     }
-
+    /**
+     * Set the connection
+     * @return connection set to initialize jdbc connection
+     * @return DepSessionFactory
+     */
     public DepSessionFactory setConnection(Connection connection){
         this.connection = connection;
         return this;
     }
 
+    /**
+     * validate whether eberything works okay
+     *
+     * @return DepSessionFactory
+     * @throws RuntimeException
+     */
     public DepSessionFactory build(){
         if (this.connection == null){
             throw new RuntimeException("Failed to build without a connection");
         }
         return this;
     }
 
+    /**
+     * Bootstrap the ORM framework and create tables
+     *
+     * @throws SQLException
+     */
     public void bootstrap() throws SQLException {
         for (Class<?> entity : entityClassList) {
             String tableName = entity.getDeclaredAnnotation(Entity.class).value();

src/test/java/lk/ijse/dep8/orm/annotations/DepSessionFactoryTest.java

@@ -1,5 +1,5 @@
 #Generated by Maven
-#Mon May 30 19:28:18 IST 2022
+#Mon May 30 21:07:28 IST 2022
 version=1.0.0
 groupId=lk.ijse.dep8
 artifactId=simple-orm-framework

target/classes/lk/ijse/dep8/orm/annotations/Bootstrap.class

@@ -1,3 +1,3 @@
 lk/ijse/dep8/orm/annotations/Id.class
-lk/ijse/dep8/orm/annotations/Bootstrap.class
 lk/ijse/dep8/orm/annotations/Entity.class
+lk/ijse/dep8/orm/DepSessionFactory.class

target/classes/lk/ijse/dep8/orm/annotations/Entity.class

@@ -1,3 +1,3 @@
-/home/chamals-pc/Desktop/IJSE DEP/phase-3/annotations/src/main/java/lk/ijse/dep8/orm/annotations/Bootstrap.java
+/home/chamals-pc/Desktop/IJSE DEP/phase-3/annotations/src/main/java/lk/ijse/dep8/orm/DepSessionFactory.java
 /home/chamals-pc/Desktop/IJSE DEP/phase-3/annotations/src/main/java/lk/ijse/dep8/orm/annotations/Entity.java
 /home/chamals-pc/Desktop/IJSE DEP/phase-3/annotations/src/main/java/lk/ijse/dep8/orm/annotations/Id.java