diff --git a/li.strolch.website/www.strolch.li/documentation-model.html b/li.strolch.website/www.strolch.li/documentation-model.html index db4c9b881..feac3b550 100644 --- a/li.strolch.website/www.strolch.li/documentation-model.html +++ b/li.strolch.website/www.strolch.li/documentation-model.html @@ -53,6 +53,217 @@
+

Before we dive into the entire model, let's show an example and how it would be modelled in Strolch and use + in Strolch:

+ Strolch model example +

A possible model would look as follows:

+ 
+<?xml version="1.0" encoding="UTF-8" ?>
+<StrolchModel xmlns="https://strolch.li/xsd/StrolchModel-1.6.xsd">
+
+    <Resource Id="Product" Name="Product Template" Type="Template">
+        <ParameterBag Id="parameters" Name="Parameters" Type="Parameters">
+            <Parameter Id="description" Name="Description" Type="String" Value=""/>
+            <Parameter Id="color" Name="Color" Type="String" Value=""/>
+            <Parameter Id="form" Name="Form" Type="String" Value=""/>
+        </ParameterBag>
+        <ParameterBag Id="relations" Name="Relations" Type="Relations">
+            <Parameter Id="articles" Name="Articles" Type="StringList" Interpretation="Resource-Ref" Uom="Article" Value=""/>
+        </ParameterBag>
+    </Resource>
+
+    <Resource Id="Article" Name="Article Template" Type="Template">
+        <ParameterBag Id="parameters" Name="Parameters" Type="Parameters">
+            <Parameter Id="description" Name="Description" Type="String" Value=""/>
+            <Parameter Id="barcode" Name="Barcode" Type="String" Value=""/>
+        </ParameterBag>
+        <ParameterBag Id="relations" Name="Relations" Type="Relations">
+            <Parameter Id="product" Name="Product" Type="String" Interpretation="Resource-Ref" Uom="Product" Value=""/>
+        </ParameterBag>
+    </Resource>
+
+    <Resource Id="Customer" Name="Customer Template" Type="Template">
+        <ParameterBag Id="address" Name="Address" Type="Address">
+            <Parameter Id="street" Name="Street" Type="String" Value=""/>
+            <Parameter Id="zip" Name="Zip" Type="String" Value=""/>
+            <Parameter Id="city" Name="City" Type="String" Value=""/>
+            <Parameter Id="country" Name="Country" Type="String" Value=""/>
+        </ParameterBag>
+    </Resource>
+
+    <Order Id="Order" Name="Order" Type="Template">
+        <ParameterBag Id="quantities" Name="Quantities per Article Id" Type="Quantities">
+            <Parameter Id="quantity" Name="Quantity" Type="Float" Value="0"/>
+        </ParameterBag>
+        <ParameterBag Id="relations" Name="Relations" Type="Relations">
+            <Parameter Id="articles" Name="Articles" Type="StringList" Interpretation="Resource-Ref" Uom="Article" Value=""/>
+            <Parameter Id="customer" Name="Customer" Type="String" Interpretation="Resource-Ref" Uom="Customer" Value=""/>
+        </ParameterBag>
+    </Order>
+
+</StrolchModel>
+

Let's go through this model:

+ + +

Now that we have a basic understanding of te model, it is of far more interest in how to create and interact + with these elements at runtime. The following listing will perform simple operations:

+ 
+try (StrolchTransaction tx = runtimeMock.openUserTx(certificate, false)) {
+
+    /*
+     * create a new product
+     */
+    Resource dafalgan = tx.getResourceTemplate("Product", true);
+    dafalgan.setName("Dafalgan 100mg");
+    dafalgan.getParameter("description", true).setValue("Dafalgan is for pain.");
+    dafalgan.getParameter("color", true).setValue("Yellow");
+    dafalgan.getParameter("form", true).setValue("flat");
+
+    StringListParameter articlesP = dafalgan.getRelationsParam("articles", true);
+
+    /*
+     * create articles
+     */
+    Resource dafalgan1 = tx.getResourceTemplate("Article", true);
+    dafalgan1.setName("Dafalgan 100mg 10 pce");
+    dafalgan1.getParameter("description", true).setValue("This is pack with 10 pieces.");
+    dafalgan1.getParameter("barcode", true).setValue("654654");
+
+    Resource dafalgan2 = tx.getResourceTemplate("Article", true);
+    dafalgan2.setName("Dafalgan 100mg 20 pce");
+    dafalgan2.getParameter("description", true).setValue("This is pack with 20 pieces.");
+    dafalgan2.getParameter("barcode", true).setValue("654655");
+
+    /*
+     * add reference to product
+     */
+    dafalgan1.getRelationParam("product").setValue(dafalgan.getId());
+    articlesP.addValue(dafalgan1.getId());
+    dafalgan2.getRelationParam("product").setValue(dafalgan.getId());
+    articlesP.addValue(dafalgan2.getId());
+
+    /*
+     * create a new customer
+     */
+    Resource customer1 = tx.getResourceTemplate("Customer", true);
+    customer1.setName("John Doe");
+
+    // set address
+    ParameterBag addressBag = customer1.getParameterBag("address", true);
+    addressBag.getParameter("street", true).setValue("Main Str. 1");
+    addressBag.getParameter("zip", true).setValue("1234");
+    addressBag.getParameter("city", true).setValue("Hometown");
+    addressBag.getParameter("country", true).setValue("Switzerland");
+
+    /*
+     * create a new order
+     */
+    Order order = tx.getOrderTemplate("Order", true);
+    order.setName("Order for " + customer1.getName());
+    order.setDate(LocalDate.of(2021, 2, 1));
+    order.setState(State.PLANNED);
+
+    // store reference to customer
+    order.getRelationParam("customer", true).setValue(customer1.getId());
+
+    StringListParameter orderArticlesP = order.getRelationsParam("articles", true);
+    ParameterBag quantitiesBag = order.getParameterBag("quantities", true);
+    FloatParameter quantityT = quantitiesBag.removeParameter("quantity");
+
+    // order quantity of 20 for Dafalgan 1
+    FloatParameter q1P = quantityT.getClone();
+    q1P.setId(dafalgan1.getId());
+    q1P.setValue(20);
+    quantitiesBag.addParameter(q1P);
+    orderArticlesP.addValue(dafalgan1.getId());
+
+    // set order quantity of 10 for Dafalgan 2
+    FloatParameter q2P = quantityT.getClone();
+    orderArticlesP.addValue(dafalgan2.getId());
+    q2P.setId(dafalgan2.getId());
+    q2P.setValue(20);
+    quantitiesBag.addParameter(q2P);
+
+    // keep IDs for later use
+    dafalganId = dafalgan.getId();
+    dafalgan1Id = dafalgan1.getId();
+    dafalgan2Id = dafalgan2.getId();
+    customerId = customer1.getId();
+    orderId = order.getId();
+
+    /*
+     * persist
+     */
+    tx.add(dafalgan);
+    tx.add(dafalgan1);
+    tx.add(dafalgan2);
+    tx.add(customer1);
+    tx.add(order);
+
+    // commit
+    tx.commitOnClose();
+}
+
+try (StrolchTransaction tx = runtimeMock.openUserTx(certificate, true)) {
+
+    // get order
+    Order order = tx.getOrderBy("Order", orderId, true);
+    assertNotNull(orderId);
+    assertEquals("Order for John Doe", order.getName());
+
+    // get customer
+    Resource customer = tx.getResourceByRelation(order, "customer", true);
+    assertNotNull(customer);
+    assertEquals("John Doe", customer.getName());
+
+    // get articles
+    List<Resource> articles = tx.getResourcesByRelation(order, "articles", true);
+    assertEquals(2, articles.size());
+
+    // get products
+    List<Resource> products = articles.stream().map(a -> tx.getResourceByRelation(a, "product", true))
+            .distinct().collect(Collectors.toList());
+    assertEquals(1, products.size());
+
+    // search for all orders in state PLANNED and with customer
+    List<Order> orders = new OrderSearch().types("Order").stateIsIn(State.PLANNED)
+            .where(ExpressionsSupport.relationParam("customer").isEqualTo(customerId)).search(tx).toList();
+    assertEquals(1, orders.size());
+}
+ +

Note: Checkout + example-model.xml + and + SimpleModelTest.java + for these examples.

+

There is a XML Schema which defines the model in XML: StrolchModel-1.6.xsd

diff --git a/li.strolch.website/www.strolch.li/images/strolch-model-example.png b/li.strolch.website/www.strolch.li/images/strolch-model-example.png new file mode 100644 index 000000000..f88f79bc7 Binary files /dev/null and b/li.strolch.website/www.strolch.li/images/strolch-model-example.png differ