|
| 1 | +# CRUD |
| 2 | + |
| 3 | +[Index](Documentation.md) |
| 4 | + |
| 5 | +GridJavaCore supports CRUD forms to add, edit, view and delete items for Blazor client-side projects. |
| 6 | + |
| 7 | +These are the supported features: |
| 8 | +- Full screen forms |
| 9 | +- Auto-generated forms with field type detection based on column definition |
| 10 | +- Lists for drop-drown fields |
| 11 | +- Custom forms |
| 12 | +- Support of grid models including 1:N relationships |
| 13 | +- Support of entities with multiple foreign keys |
| 14 | +- Direct URLs |
| 15 | + |
| 16 | +## Auto-generated forms |
| 17 | + |
| 18 | +You will need a controller supporting 4 web services to perform the CRUD operation on the back-end. This is an example of this type of controller: |
| 19 | + |
| 20 | +```java |
| 21 | +@RestController |
| 22 | +@RequiredArgsConstructor |
| 23 | +@RequestMapping(value = "/api") |
| 24 | +public class OrderController { |
| 25 | + |
| 26 | + private final OrderRepository orderRepository; |
| 27 | + private final CustomerRepository customerRepository; |
| 28 | + private final EmployeeRepository employeeRepository; |
| 29 | + private final ShipperRepository shipperRepository; |
| 30 | + |
| 31 | + @GetMapping(value = {"/order", "/Order"}) |
| 32 | + public ResponseEntity<List<Order>> getAll() { |
| 33 | + return ResponseEntity.ok(orderRepository.findAll()); |
| 34 | + } |
| 35 | + |
| 36 | + @PostMapping(value = {"/order", "/Order"}) |
| 37 | + public ResponseEntity<Object> create(@RequestBody Order order) { |
| 38 | + |
| 39 | + try { |
| 40 | + if(order.getCustomerID() != null && ! order.getCustomerID().isBlank()) { |
| 41 | + var customer = customerRepository.findById(order.getCustomerID()); |
| 42 | + customer.ifPresent(order::setCustomer); |
| 43 | + } |
| 44 | + if(order.getEmployeeID() != null) { |
| 45 | + var employee = employeeRepository.findById(order.getEmployeeID()); |
| 46 | + employee.ifPresent(order::setEmployee); |
| 47 | + } |
| 48 | + if(order.getShipVia() != null) { |
| 49 | + var shipper = shipperRepository.findById(order.getShipVia()); |
| 50 | + shipper.ifPresent(order::setShipper); |
| 51 | + } |
| 52 | + Order savedOrder = orderRepository.saveAndFlush(order); |
| 53 | + return ResponseEntity.ok(savedOrder.getOrderID()); |
| 54 | + } |
| 55 | + catch (Exception e) { |
| 56 | + return ResponseEntity.badRequest() |
| 57 | + .body(e.getMessage().replace('{', '(').replace('}', ')')); |
| 58 | + } |
| 59 | + } |
| 60 | + |
| 61 | + @GetMapping(value = {"/order/{id}", "/Order/{id}"}) |
| 62 | + public ResponseEntity<Order> get(@PathVariable int id) { |
| 63 | + |
| 64 | + Optional<Order> order = orderRepository.findById(id); |
| 65 | + return order.map(ResponseEntity::ok).orElseGet(() -> ResponseEntity.notFound().build()); |
| 66 | + } |
| 67 | + |
| 68 | + @PutMapping(value = {"/order/{id}", "/Order/{id}"}) |
| 69 | + public ResponseEntity<Object> update(@RequestBody Order order, @PathVariable int id) { |
| 70 | + |
| 71 | + Optional<Order> attachedOrder = orderRepository.findById(id); |
| 72 | + if (attachedOrder.isEmpty()) |
| 73 | + return ResponseEntity.notFound().build(); |
| 74 | + |
| 75 | + try { |
| 76 | + order.setOrderID(id); |
| 77 | + if(order.getCustomerID() != null && ! order.getCustomerID().isBlank() |
| 78 | + && !order.getCustomerID().equals(attachedOrder.get().getCustomerID())) { |
| 79 | + var customer = customerRepository.findById(order.getCustomerID()); |
| 80 | + customer.ifPresent(order::setCustomer); |
| 81 | + } |
| 82 | + if(order.getEmployeeID() != null && !order.getEmployeeID().equals(attachedOrder.get().getEmployeeID())) { |
| 83 | + var employee = employeeRepository.findById(order.getEmployeeID()); |
| 84 | + employee.ifPresent(order::setEmployee); |
| 85 | + } |
| 86 | + if(order.getShipVia() != null && !order.getShipVia().equals(attachedOrder.get().getShipVia())) { |
| 87 | + var shipper = shipperRepository.findById(order.getShipVia()); |
| 88 | + shipper.ifPresent(order::setShipper); |
| 89 | + } |
| 90 | + orderRepository.saveAndFlush(order); |
| 91 | + return ResponseEntity.noContent().build(); |
| 92 | + } |
| 93 | + catch (Exception e) { |
| 94 | + return ResponseEntity.badRequest() |
| 95 | + .body(e.getMessage().replace('{', '(').replace('}', ')')); |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + @DeleteMapping(value = {"/order/{id}", "/Order/{id}"}) |
| 100 | + public ResponseEntity<Object> delete(@PathVariable int id) { |
| 101 | + |
| 102 | + Optional<Order> order = orderRepository.findById(id); |
| 103 | + if (order.isEmpty()) |
| 104 | + return ResponseEntity.notFound().build(); |
| 105 | + |
| 106 | + try { |
| 107 | + orderRepository.delete(order.get()); |
| 108 | + orderRepository.flush(); |
| 109 | + return ResponseEntity.noContent().build(); |
| 110 | + } |
| 111 | + catch (Exception e) { |
| 112 | + return ResponseEntity.badRequest() |
| 113 | + .body(e.getMessage().replace('{', '(').replace('}', ')')); |
| 114 | + } |
| 115 | + } |
| 116 | +} |
| 117 | +``` |
| 118 | + |
| 119 | +## Column definition |
| 120 | + |
| 121 | +The column definition must include the primary keys: |
| 122 | +- using the **setPrimaryKey(true)** method for columns with auto-generated keys, or |
| 123 | +- using the **setPrimaryKey(true, false)** method for columns with manually generated keys |
| 124 | + |
| 125 | +This is an example of column definition: |
| 126 | + |
| 127 | +```java |
| 128 | +Consumer<IGridColumnCollection<Order>> columns = c -> { |
| 129 | + c.add("orderID", Integer.class).setPrimaryKey(true); |
| 130 | + c.add("customerID", String.class); |
| 131 | + c.add("employeeID", Integer.class); |
| 132 | + c.add("shipVia", Integer.class, true); |
| 133 | + c.add("orderDate", LocalDateTime.class, "orderCustomDate"); |
| 134 | + c.add("customer.companyName", String.class); |
| 135 | + c.add("customer.contactName", String.class); |
| 136 | + c.add("freight", BigDecimal.class); |
| 137 | + c.add("customer.isVip",Boolean.class); |
| 138 | + c.add("requiredDate", LocalDateTime.class, true); |
| 139 | + c.add("shippedDate", LocalDateTime.class, true); |
| 140 | + c.add("shipName", String.class, true); |
| 141 | + c.add("shipAddress", String.class, true); |
| 142 | + c.add("shipCity", String.class, true); |
| 143 | + c.add("shipPostalCode", String.class, true); |
| 144 | + c.add("shipRegion", String.class, true); |
| 145 | + c.add("shipCountry", String.class, true); |
| 146 | +}; |
| 147 | +``` |
| 148 | + |
| 149 | +This is an example of a grid using CRUD: |
| 150 | + |
| 151 | + |
| 152 | + |
| 153 | +And this is an auto-genereated edit form: |
| 154 | + |
| 155 | + |
| 156 | + |
| 157 | +[<- Front-end back-end API](API.md) |
0 commit comments