diff --git a/qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/data/QRecordWithJoinedRecords.java b/qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/data/QRecordWithJoinedRecords.java new file mode 100644 index 00000000..aa773687 --- /dev/null +++ b/qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/data/QRecordWithJoinedRecords.java @@ -0,0 +1,201 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +package com.kingsrook.qqq.backend.core.model.data; + + +import java.io.Serializable; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.function.BiFunction; + + +/******************************************************************************* + ** Extension on QRecord, intended to be used where you've got records from + ** multiple tables, and you want to combine them into a single "wide" joined + ** record - but to do so without copying or modifying any of the individual + ** records. + ** + ** e.g., given: + ** - Order (id, orderNo, orderDate) (main table) + ** - LineItem (id, sku, quantity) + ** - Extrinsic (id, key, value) + ** + ** If set up in here as: + ** - new QRecordWithJoinedRecords(order) + ** .withJoinedRecordValues(lineItem) + ** .withJoinedRecordValues(extrinsic) + ** + ** Then we'd have the appearance of values in the object like: + ** - id, orderNo, orderDate, lineItem.id, lineItem.sku, lineItem.quantity, extrinsic.id, extrinsic.key, extrinsic.value + ** + ** Which, by the by, is how a query that returns joined records looks, and, is + ** what BackendQueryFilterUtils can use to do filter. + ** + ** This is done without copying or mutating any of the records (which, if you just use + ** QRecord.withJoinedRecordValues, then those values are copied into the main record) + ** - because this object is just storing references to the input records. + ** + ** Note that this implies that, values changed in this record (e.g, calls to setValue) + ** WILL impact the underlying records! + *******************************************************************************/ +public class QRecordWithJoinedRecords extends QRecord +{ + private QRecord mainRecord; + private Map components = new LinkedHashMap<>(); + + + /*************************************************************************** + ** + ***************************************************************************/ + public QRecordWithJoinedRecords(QRecord mainRecord) + { + this.mainRecord = mainRecord; + } + + + + /************************************************************************* + ** + ***************************************************************************/ + @Override + public void addJoinedRecordValues(String joinTableName, QRecord joinedRecord) + { + components.put(joinTableName, joinedRecord); + } + + + + /************************************************************************* + ** + ***************************************************************************/ + public QRecordWithJoinedRecords withJoinedRecordValues(QRecord record, String joinTableName) + { + addJoinedRecordValues(joinTableName, record); + return (this); + } + + + + /*************************************************************************** + ** + ***************************************************************************/ + @Override + public Serializable getValue(String fieldName) + { + return performFunctionOnRecordBasedOnFieldName(fieldName, ((record, f) -> record.getValue(f))); + } + + + + /*************************************************************************** + * + ***************************************************************************/ + @Override + public void setValue(String fieldName, Object value) + { + performFunctionOnRecordBasedOnFieldName(fieldName, ((record, f) -> + { + record.setValue(f, value); + return (null); + })); + } + + + + /*************************************************************************** + * + ***************************************************************************/ + @Override + public void setValue(String fieldName, Serializable value) + { + performFunctionOnRecordBasedOnFieldName(fieldName, ((record, f) -> + { + record.setValue(f, value); + return (null); + })); + } + + + + /*************************************************************************** + ** + ***************************************************************************/ + @Override + public void removeValue(String fieldName) + { + performFunctionOnRecordBasedOnFieldName(fieldName, ((record, f) -> + { + record.removeValue(f); + return (null); + })); + } + + + + /*************************************************************************** + ** avoid having this same block in all the functions that call it... + ** given a fieldName, which may be a joinTable.fieldName, apply the function + ** to the right entity. + ***************************************************************************/ + private Serializable performFunctionOnRecordBasedOnFieldName(String fieldName, BiFunction functionToPerform) + { + if(fieldName.contains(".")) + { + String[] parts = fieldName.split("\\."); + QRecord component = components.get(parts[0]); + if(component != null) + { + return functionToPerform.apply(component, parts[1]); + } + else + { + return null; + } + } + else + { + return functionToPerform.apply(mainRecord, fieldName); + } + } + + + + /*************************************************************************** + ** + ***************************************************************************/ + @Override + public Map getValues() + { + Map rs = new LinkedHashMap<>(mainRecord.getValues()); + for(Map.Entry componentEntry : components.entrySet()) + { + String joinTableName = componentEntry.getKey(); + QRecord componentRecord = componentEntry.getValue(); + for(Map.Entry entry : componentRecord.getValues().entrySet()) + { + rs.put(joinTableName + "." + entry.getKey(), entry.getValue()); + } + } + return (rs); + } + +} diff --git a/qqq-backend-core/src/test/java/com/kingsrook/qqq/backend/core/model/data/QRecordWithJoinedRecordsTest.java b/qqq-backend-core/src/test/java/com/kingsrook/qqq/backend/core/model/data/QRecordWithJoinedRecordsTest.java new file mode 100644 index 00000000..2eb372d0 --- /dev/null +++ b/qqq-backend-core/src/test/java/com/kingsrook/qqq/backend/core/model/data/QRecordWithJoinedRecordsTest.java @@ -0,0 +1,76 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2025. Kingsrook, LLC + * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States + * contact@kingsrook.com + * https://github.com/Kingsrook/ + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +package com.kingsrook.qqq.backend.core.model.data; + + +import java.time.LocalDate; +import java.time.Month; +import com.kingsrook.qqq.backend.core.BaseTest; +import org.junit.jupiter.api.Test; +import static org.junit.jupiter.api.Assertions.assertEquals; + + +/******************************************************************************* + ** Unit test for QRecordWithJoinedRecords + *******************************************************************************/ +class QRecordWithJoinedRecordsTest extends BaseTest +{ + + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void test() + { + QRecord order = new QRecord().withValue("id", 1).withValue("orderNo", "101").withValue("orderDate", LocalDate.of(2025, Month.JANUARY, 1)); + QRecord lineItem = new QRecord().withValue("id", 2).withValue("sku", "ABC").withValue("quantity", 47); + QRecord extrinsic = new QRecord().withValue("id", 3).withValue("key", "MyKey").withValue("value", "MyValue"); + + QRecordWithJoinedRecords joinedRecords = new QRecordWithJoinedRecords(order); + joinedRecords.addJoinedRecordValues("lineItem", lineItem); + joinedRecords.addJoinedRecordValues("extrinsic", extrinsic); + + assertEquals(1, joinedRecords.getValue("id")); + assertEquals("101", joinedRecords.getValue("orderNo")); + assertEquals(LocalDate.of(2025, Month.JANUARY, 1), joinedRecords.getValue("orderDate")); + assertEquals(2, joinedRecords.getValue("lineItem.id")); + assertEquals("ABC", joinedRecords.getValue("lineItem.sku")); + assertEquals(47, joinedRecords.getValue("lineItem.quantity")); + assertEquals(3, joinedRecords.getValue("extrinsic.id")); + assertEquals("MyKey", joinedRecords.getValue("extrinsic.key")); + assertEquals("MyValue", joinedRecords.getValue("extrinsic.value")); + + assertEquals(9, joinedRecords.getValues().size()); + assertEquals(1, joinedRecords.getValues().get("id")); + assertEquals(2, joinedRecords.getValues().get("lineItem.id")); + assertEquals(3, joinedRecords.getValues().get("extrinsic.id")); + + joinedRecords.setValue("lineItem.color", "RED"); + assertEquals("RED", joinedRecords.getValue("lineItem.color")); + assertEquals("RED", lineItem.getValue("color")); + + joinedRecords.setValue("shipToCity", "St. Louis"); + assertEquals("St. Louis", joinedRecords.getValue("shipToCity")); + assertEquals("St. Louis", order.getValue("shipToCity")); + } + +} \ No newline at end of file