Expanded docs

Signed-off-by: Gerolmed <[email protected]>

Author: Gerolmed

.idea/jarRepositories.xml

@@ -4,9 +4,12 @@ Adapter to allow using and switching different backends in Java without a proble
 
 **Features:**
  - Easy setup and usage
- - Easy query building that translates into all supported datbases.
+ - Easy query building that translates into all supported databases.
  - Automatic java object <-> database entity conversion
  - Support to define serializers for existing classes like java.util.Date
+ 
+ RealmDrive **supports abstract classes/interfaces** (sub classes must be registered).
+ [More about sub classes here](./docs/sub-class.md)
 
 Currently supported database systems:
  - MongoDB

README.md

@@ -0,0 +1,70 @@
+Realm Drive allows defining sub and abstract classes.
+
+> **Note** this only works, if the object was saved with RealmDrive.
+
+#### Example:
+
+> Removed getter/setter/noargs constructor/allargs constructor for simplicity
+
+**Model classes**
+```java
+import net.endrealm.realmdrive.annotations.SaveAll;
+
+@SaveAll
+public class MyObject {
+    private DynamicInput input;
+}
+
+/**
+* This could also be a normal/abstract class
+*/
+public interface DynamicInput {
+    String getAddress();
+}
+
+@SaveAll
+public class Input1 implements DynamicInput {
+    private String street;
+    private int houseNr;
+    
+    public String getAddress() {
+        return street + " " + houseNr;
+    }
+}
+
+@SaveAll
+public class Input2 implements DynamicInput {
+    private double longitude;
+    private double latitude;
+    
+    public String getAddress() {
+        return someLatLongToAddressCode(this);
+    }
+}
+```
+
+**Usage example**
+```java
+public class Main {
+    public static void main(String[] args) {
+        DriveService service = ...; // Get your service
+
+        // Register classes
+        service.getConversionHandler()
+            .registerClasses(MyObject.class, Input1.class, Input2.class);
+        
+        // Create example objects
+        MyObject obj1 = new MyObject(new Input1("adams-street", 14));
+        MyObject obj2 = new MyObject(new Input2(12.2, 12.2));
+        
+        service.getWriter().write(obj1);
+        service.getWriter().write(obj2);
+
+        Query query = new Query().build(); // select all
+        List<MyObject> all = service.getReader().readAll(query, GreatEntity.class);
+    
+        assert all.get(0).equals(obj1);
+        assert all.get(1).equals(obj2);
+    }
+}
+```

docs/sub-class.md

@@ -54,6 +54,8 @@ Realm Drive can automatically find a constructor matching the type/super type of
 
 Examples can be found [here](./inject-parent.md)
 
+**Find out how powerful sub classes can be with RealmDrive [here](sub-class.md)
+
 #### Marking fields
 Read more about it [here](./annotations.md)
 #### Register classes

docs/usage.md

@@ -4,7 +4,7 @@
 
     <artifactId>realm-drive</artifactId>
     <groupId>net.endrealm</groupId>
-    <version>1.3.0-SNAPSHOT</version>
+    <version>1.3.1-RELEASE</version>
     <name>Realm Drive</name>
     <description>
         A database adapter allowing to switch different databases without requiring users to change their code.