Update README.md

Author: tdilber

README.md

@@ -1,27 +1,77 @@
 # JPA - EXTENSION
 
-TODOs:
+This project look like QueryDsl but main purpuse is query creation with simple DTO (Pojo) objects. So we can simply ingrate with frontend application filters or somethings. Received query converted to Jpa Specification object and this Specification<Entity> executed on JpaSpecificationExecutor<Entity> repository. 
+  
+```java
+  
+   // Entity
+  @Entity
+  @Table(name = "customer")
+  public class Customer implements Serializable {
 
-- All Tests
-- Convert tumple to Object (done)
-- Extend JpaRepository (done)
-- Spring Boot Service For Data Fetch (done)
-- Linq For Java (done)
-- A Repository For Linq Support (done)
-- Parantesis Support (done)
-- not just inner join support, all joins support (done)
+      private static final long serialVersionUID = 1L;
 
-customerRepository.query() <br />
-.select(Select("user.name", "name"), Select("user.age"), Select("name", "surname"), Select("birthdate" , "
-birthdate"))<br />
-.distinct(false)<br />
-.where(Parantesis(Field("id").eq(3), OR, Field("user.id").eq(4), OR, Field("id").eq(5)), Parantesis(Field("id").eq(6),
-OR, Field("id").eq(4), OR, Field("user.id").eq(5)))<br />
-.orderBy(OrderBy("user.name", Order.ASC))<br />
-.page(0, 5)<br />
-.getResult(User.class);<br />
+      @Id
+      @GeneratedValue(strategy = GenerationType.IDENTITY)
+      private Long id;
 
-Next Version Things
+      @Column(name = "name")
+      private String name;
 
-- Web Authorization Support.
-- Web Rest Parameter Resolver.
+      @Column(name = "age")
+      private Integer age;
+
+      @Column(name = "birthdate")
+      private Instant birthdate;
+
+      @ManyToOne
+      private User user;
+  
+      // getter - setters 
+  }
+  
+  // Repository Creation
+  @Repository
+  public interface CustomerRepository extends JpaExtendedRepository<Customer, Long> {
+  }
+  
+   // Usage
+   // SELECT * FROM customer WHERE age >= 18
+   customerRepository.findAllWithCriteria(Arrays.asList(Criteria.of("age", CriteriaType.GREATER_THAN_OR_EQUAL, 18)));
+   
+   // Default AND operation apply on list of all criterias.
+   // SELECT * FROM customer WHERE age >= 18 AND id < 10
+   customerRepository.findAllWithCriteria(Arrays.asList(
+                                 Criteria.of("age", CriteriaType.GREATER_THAN_OR_EQUAL, 18),
+                                 Criteria.of("id", CriteriaType.LESS_THAN, 10)
+                                 ));
+                                                        
+  // OR Usage 
+  // SELECT * FROM customer WHERE age >= 18 OR id < 10
+  customerRepository.findAllWithCriteria(Arrays.asList(
+                                 Criteria.of("age", CriteriaType.GREATER_THAN_OR_EQUAL, 18),
+                                 Criteria.of("", CriteriaType.OR),
+                                 Criteria.of("id", CriteriaType.LESS_THAN, 10)
+                                 ));
+                                                        
+  // Joinning Usage
+  // SELECT c.* FROM customer c INNER JOIN user u ON c.user_id=u.id WHERE u.surname LIKE '%son%'
+   customerRepository.findAllWithCriteria(Arrays.asList(Criteria.of("user.surname", CriteriaType.CONTAIN, "son")));
+                                                      
+  // SELECT c.* FROM customer c LEFT JOIN user u ON c.user_id=u.id WHERE u.surname LIKE '%son%'
+   customerRepository.findAllWithCriteria(Arrays.asList(Criteria.of("user<surname", CriteriaType.CONTAIN, "son")));
+ 
+  // SELECT c.* FROM customer c RIGHT JOIN user u ON c.user_id=u.id WHERE u.surname LIKE '%son%'
+   customerRepository.findAllWithCriteria(Arrays.asList(Criteria.of("user>surname", CriteriaType.CONTAIN, "son")));
+                                                      
+                                                      
+  // Powerfull Usage
+  // SELECT c.* FROM customer c INNER JOIN user u ON c.user_id=u.id WHERE (u.surname LIKE '%son%' AND c.age >= 18) OR (u.name LIKE '%ander%' AND c.id < 10)
+   customerRepository.findAllWithCriteria(Arrays.asList(
+                                                      Criteria.of("user.surname", CriteriaType.CONTAIN, "son"),
+                                                      Criteria.of("age", CriteriaType.GREATER_THAN_OR_EQUAL, 18),
+                                                      Criteria.of("", CriteriaType.OR),
+                                                      Criteria.of("user.name", CriteriaType.CONTAIN, "ander"),
+                                                      Criteria.of("id", CriteriaType.LESS_THAN, 10)
+                                                      ));
+```