Documentation added

Author: sfxcode

src/main/paradox/dao/base.md

@@ -0,0 +1,37 @@
+# MongoDAO - Base Functions
+
+## Info
+
+Base Collection functions. All functions support synchronous result handling (add Result to function name, e.g. drop -> dropResult).
+
+## Drop
+
+Drop Collection.
+
+```scala
+def drop(): Observable[Completed]
+```
+
+## Count
+
+Count of collection with optional filter.
+
+```scala
+def count(filter: Bson = Document()): Observable[Long]
+```
+
+## Indexes
+
+```scala
+
+def createIndex(key: Bson, options: IndexOptions = IndexOptions()): SingleObservable[String]
+
+// Simple Index creation
+def createIndexForField(field: String, sortAscending: Boolean = true): SingleObservable[String]
+
+def dropIndex(keys: Bson): SingleObservable[Completed]
+
+// Simple Index delete
+def dropIndexForName(name: String): SingleObservable[Completed]
+
+```

src/main/paradox/dao/crud.md

@@ -0,0 +1,44 @@
+# MongoDAO - CRUD Functions
+
+## Info
+
+CRUD Collection functions. All functions support synchronous result handling (add Result to function name, e.g. drop -> dropResult).
+
+## Create
+
+```scala
+
+def insertOne(value: A): Observable[Completed]
+
+def insertOne(value: A), options: InsertOneOptions: Observable[Completed]
+
+def insertMany(values: Seq[A]): Observable[Completed]
+
+def insertMany(values: Seq[A], options: InsertManyOptions): Observable[Completed]
+
+```
+
+## Update
+
+```scala
+
+def replaceOne(value: A): Observable[UpdateResult]
+
+def replaceOne(value: A, options: ReplaceOptions): Observable[UpdateResult]
+
+```
+
+## Delete
+
+```scala
+
+def deleteOne(value: A): Observable[DeleteResult]
+
+def deleteOne(filter: Bson): Observable[DeleteResult]
+
+def deleteMany(filter: Bson): Observable[DeleteResult]
+
+def deleteAll(): Observable[DeleteResult]
+
+
+```

src/main/paradox/dao/mongo_dao.md

@@ -0,0 +1,30 @@
+# MongoDAO - Overview
+
+## Info
+
+MongoDAO is the core of this framework.  The [DAO](https://en.wikipedia.org/wiki/Data_access_object) Pattern simplifies database usage.
+
+The MongoDAO object holds a reference to a [MongoCollection](http://mongodb.github.io/mongo-scala-driver/2.3/scaladoc/org/mongodb/scala/MongoCollection.html) and adds functions for easy collection handling.
+
+All functions support synchronous result handling (add Result to function name, e.g. drop -> dropResult, insert ->insertResult).
+
+## Features
+
+* @ref:[MongoDAO Base](base.md) (Drop, Index, Count)
+* @ref:[MongoDAO CRUD](crud.md) (Create, Insert, Delete)
+* @ref:[MongoDAO Search](search.md) (Search, Distinct, Aggregate)
+
+## Creation
+
+A [MongoDatabase](http://mongodb.github.io/mongo-scala-driver/2.3/scaladoc/org/mongodb/scala/MongoDatabase.html) and a collection name is needed.
+
+A Type Parameter is used for automatic Document to Class conversion (case classes needs to be registered).
+
+
+```scala
+  object RestaurantDAO extends MongoDAO[Restaurant](database, "restaurants")
+```
+
+
+
+

src/main/paradox/dao/search.md

@@ -0,0 +1,25 @@
+# MongoDAO - Search Functions
+
+## Info
+
+## Demo
+
+### Setup imports
+
+```scala
+// Filter helper functions
+import com.sfxcode.nosql.mongo.Filter._
+// sort helper functions
+import com.sfxcode.nosql.mongo.Sort._
+// implicits like Document from Map ...
+import com.sfxcode.nosql.mongo._
+```
+
+### Execute Search
+
+```scala
+val females = PersonDAO.find(Map("gender" -> "female"), 
+    sortByKey("name")).resultList()
+
+
+```

src/main/paradox/features/aggregation.md

@@ -0,0 +1,31 @@
+# Features - Aggregation
+
+## Info
+
+MongoDB support an easy to use [Aggregation Handling](https://docs.mongodb.com/manual/aggregation/).
+
+## Demo
+
+### Setup imports
+
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/operation/AggregationSpec.scala) { #agg_imports }
+
+### Define stages
+
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/operation/AggregationSpec.scala) { #agg_stages }
+
+### Execute Aggregation
+
+@@@ note { title=Important }
+
+In most cases we have to use the RAW attribute, because the aggregation result not follows the case class pattern. RAW returns always Documents instead of case classes.
+
+@@@
+
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/operation/AggregationSpec.scala) { #agg_execute }
+
+### Convert Result
+
+For easy result handling, using the implicit Document to Map conversion can be useful.
+
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/operation/AggregationSpec.scala) { #agg_convert }

src/main/paradox/features/converter.md

@@ -0,0 +1,4 @@
+# Features - BSON Converter
+
+## Info
+

src/main/paradox/features/relationships.md

@@ -0,0 +1,50 @@
+# Features - Relationships
+
+## Info
+
+Normal Relationship handling is the use of [embedded documents](https://docs.mongodb.com/manual/tutorial/model-embedded-one-to-one-relationships-between-documents/).
+However, sometimes there is a need for [relationsips beetween collections](https://docs.mongodb.com/manual/tutorial/model-referenced-one-to-many-relationships-between-documents/). There is a Relations Trait to be used in case classes for easy relationship handling.
+
+## Relations trait
+
+The Relations trait extends DAO case classes with relationship functions.
+
+* relatedRecordForOneToOne (OneToOneRelationship and reference vlue needed)
+* relatedRecordsForOneToMany (OneToManyRelationship and reference vlue needed)
+
+## Demo
+
+Simple Setup.
+
+* User Collection(should have one login and multiple friends)
+* Login Collection
+* Friend Collection
+
+```scala
+
+  case class User(id: Long, name: String, loginId: String)
+  case class Login(id: String, email: String, password: String)
+  case class Friend(id: Long, name: String, userId: Long)
+  
+  object UserDAO extends MongoDAO[User](database, "user") 
+  object LoginDAO extends MongoDAO[Login](database, "login")
+  object FriendDAO extends MongoDAO[Friend](database, "friend")
+  
+```
+
+For relationship setup we create two Relationships in the UserDAO.
+
+* OneToOne loginRelation  (LoginDAO, key is id in user collection)
+* OneToMany friendsRelation (FriendDAO, key is userId in friend collection)
+
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/relation/RelationDemoDatabase.scala) { #user_dao }
+
+
+We extend the User case class with the Relations trait and add relation specific functions.
+
+* login (create an Option of Login)
+* friends (create a List of Friend)
+
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/relation/RelationDemoDatabase.scala) { #user_class }
+
+

src/main/paradox/index.md

@@ -31,6 +31,12 @@ Documentation for [MongoDB](https://docs.mongodb.com/)
  - [Tutorial Setup](tutorial/setup.md)
  - [Tutorial Database](tutorial/database.md)
  - [Tutorial Application](tutorial/application.md)
+ - [MongoDAO Overview](dao/mongo_dao.md)
+ - [MongoDAO Base](dao/base.md)
+ - [MongoDAO CRUD](dao/crud.md)
+ - [MongoDAO Search](dao/search.md)
+ - [Feature Aggregation](features/aggregation.md)
+ - [Feature Relationships](features/relationships.md)
  - [Changes ](changes.md)
 
 @@@

src/main/paradox/tutorial/application.md

@@ -6,10 +6,10 @@ This Demo Application should demonstrate the basic usage of simple-mongo.
 
 ## Imports
 
-@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/restaurant/RestaurantApp.scala) { #import }
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoDatabase.scala) { #import }
 
 
 ## Simple Application
 
-@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/restaurant/RestaurantApp.scala) { #app }
+@@snip [RestaurantApp](../../../test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoApp.scala) { #app }
 

src/main/paradox/tutorial/database.md

@@ -6,22 +6,22 @@ The database provides static import to our [DAO](https://en.wikipedia.org/wiki/D
 
 ## Imports
 
-@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/restaurant/RestaurantDatabase.scala) { #import }
+@@snip [RestaurantDatabase.scala](../../../test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoDatabase.scala) { #import }
 
 
 ## case classes for document representation
 
-@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/restaurant/RestaurantDatabase.scala) { #case_classes }
+@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoDatabase.scala) { #case_classes }
 
 ## Registry and database
 
 scala-mongo-driver use a registry pattern for deserialization
 
-@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/restaurant/RestaurantDatabase.scala) { #registry }
+@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoDatabase.scala) { #registry }
 
 ## Restaurant DAO
 
-@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/restaurant/RestaurantDatabase.scala) { #dao }
+@@snip [RestaurantDatabase](../../../test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoDatabase.scala) { #dao }
 
 ## Usage
 * Create Database object