Add GET action, and usage in API

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/actions/interfaces/GetInterface.java

@@ -0,0 +1,40 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  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 <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.actions.interfaces;
+
+
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetOutput;
+
+
+/*******************************************************************************
+ ** Interface for the Get action.
+ **
+ *******************************************************************************/
+public interface GetInterface
+{
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   GetOutput execute(GetInput getInput) throws QException;
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/actions/tables/GetAction.java

@@ -0,0 +1,161 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  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 <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.actions.tables;
+
+
+import java.util.List;
+import java.util.Optional;
+import java.util.function.Function;
+import com.kingsrook.qqq.backend.core.actions.ActionHelper;
+import com.kingsrook.qqq.backend.core.actions.customizers.QCodeLoader;
+import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizers;
+import com.kingsrook.qqq.backend.core.actions.interfaces.GetInterface;
+import com.kingsrook.qqq.backend.core.actions.values.QPossibleValueTranslator;
+import com.kingsrook.qqq.backend.core.actions.values.QValueFormatter;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetOutput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryOutput;
+import com.kingsrook.qqq.backend.core.model.data.QRecord;
+import com.kingsrook.qqq.backend.core.modules.backend.QBackendModuleDispatcher;
+import com.kingsrook.qqq.backend.core.modules.backend.QBackendModuleInterface;
+
+
+/*******************************************************************************
+ ** Action to run a get against a table.
+ **
+ *******************************************************************************/
+public class GetAction
+{
+   private Optional<Function<QRecord, QRecord>> postGetRecordCustomizer;
+
+   private GetInput                 getInput;
+   private QValueFormatter          qValueFormatter;
+   private QPossibleValueTranslator qPossibleValueTranslator;
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public GetOutput execute(GetInput getInput) throws QException
+   {
+      ActionHelper.validateSession(getInput);
+
+      postGetRecordCustomizer = QCodeLoader.getTableCustomizerFunction(getInput.getTable(), TableCustomizers.POST_QUERY_RECORD.getRole());
+      this.getInput = getInput;
+
+      QBackendModuleDispatcher qBackendModuleDispatcher = new QBackendModuleDispatcher();
+      QBackendModuleInterface  qModule                  = qBackendModuleDispatcher.getQBackendModule(getInput.getBackend());
+      // todo pre-customization - just get to modify the request?
+
+      GetInterface getInterface = null;
+      try
+      {
+         getInterface = qModule.getGetInterface();
+      }
+      catch(IllegalStateException ise)
+      {
+         ////////////////////////////////////////////////////////////////////////////////////////////////
+         // if a module doesn't implement Get directly - try to do a Get by a Query by the primary key //
+         // see below.                                                                                 //
+         ////////////////////////////////////////////////////////////////////////////////////////////////
+      }
+
+      GetOutput getOutput;
+      if(getInterface != null)
+      {
+         getOutput = getInterface.execute(getInput);
+      }
+      else
+      {
+         getOutput = performGetViaQuery(getInput);
+      }
+
+      if(getOutput.getRecord() != null)
+      {
+         getOutput.setRecord(postRecordActions(getOutput.getRecord()));
+      }
+
+      return getOutput;
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   private GetOutput performGetViaQuery(GetInput getInput) throws QException
+   {
+      QueryInput queryInput = new QueryInput(getInput.getInstance());
+      queryInput.setSession(getInput.getSession());
+      queryInput.setTableName(getInput.getTableName());
+      queryInput.setFilter(new QQueryFilter().withCriteria(new QFilterCriteria(getInput.getTable().getPrimaryKeyField(), QCriteriaOperator.EQUALS, List.of(getInput.getPrimaryKey()))));
+      QueryOutput queryOutput = new QueryAction().execute(queryInput);
+
+      GetOutput getOutput = new GetOutput();
+      if(!queryOutput.getRecords().isEmpty())
+      {
+         getOutput.setRecord(queryOutput.getRecords().get(0));
+      }
+      return (getOutput);
+   }
+
+
+
+   /*******************************************************************************
+    ** Run the necessary actions on a record.  This may include setting display values,
+    ** translating possible values, and running post-record customizations.
+    *******************************************************************************/
+   public QRecord postRecordActions(QRecord record)
+   {
+      QRecord returnRecord = record;
+      if(this.postGetRecordCustomizer.isPresent())
+      {
+         returnRecord = postGetRecordCustomizer.get().apply(record);
+      }
+
+      if(getInput.getShouldTranslatePossibleValues())
+      {
+         if(qPossibleValueTranslator == null)
+         {
+            qPossibleValueTranslator = new QPossibleValueTranslator(getInput.getInstance(), getInput.getSession());
+         }
+         qPossibleValueTranslator.translatePossibleValuesInRecords(getInput.getTable(), List.of(returnRecord));
+      }
+
+      if(getInput.getShouldGenerateDisplayValues())
+      {
+         if(qValueFormatter == null)
+         {
+            qValueFormatter = new QValueFormatter();
+         }
+         qValueFormatter.setDisplayValuesInRecords(getInput.getTable(), List.of(returnRecord));
+      }
+
+      return (returnRecord);
+   }
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/tables/get/GetInput.java

@@ -0,0 +1,186 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  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 <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.model.actions.tables.get;
+
+
+import java.io.Serializable;
+import com.kingsrook.qqq.backend.core.actions.QBackendTransaction;
+import com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput;
+import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
+import com.kingsrook.qqq.backend.core.model.session.QSession;
+
+
+/*******************************************************************************
+ ** Input data for the Get action
+ **
+ *******************************************************************************/
+public class GetInput extends AbstractTableActionInput
+{
+   private QBackendTransaction transaction;
+   private Serializable        primaryKey;
+
+   private boolean shouldTranslatePossibleValues = false;
+   private boolean shouldGenerateDisplayValues   = false;
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public GetInput()
+   {
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public GetInput(QInstance instance)
+   {
+      super(instance);
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   public GetInput(QInstance instance, QSession session)
+   {
+      super(instance);
+      setSession(session);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for primaryKey
+    **
+    *******************************************************************************/
+   public Serializable getPrimaryKey()
+   {
+      return primaryKey;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for primaryKey
+    **
+    *******************************************************************************/
+   public void setPrimaryKey(Serializable primaryKey)
+   {
+      this.primaryKey = primaryKey;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for primaryKey
+    **
+    *******************************************************************************/
+   public GetInput withPrimaryKey(Serializable primaryKey)
+   {
+      this.primaryKey = primaryKey;
+      return (this);
+   }
+  
+
+
+   /*******************************************************************************
+    ** Getter for shouldTranslatePossibleValues
+    **
+    *******************************************************************************/
+   public boolean getShouldTranslatePossibleValues()
+   {
+      return shouldTranslatePossibleValues;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for shouldTranslatePossibleValues
+    **
+    *******************************************************************************/
+   public void setShouldTranslatePossibleValues(boolean shouldTranslatePossibleValues)
+   {
+      this.shouldTranslatePossibleValues = shouldTranslatePossibleValues;
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for shouldGenerateDisplayValues
+    **
+    *******************************************************************************/
+   public boolean getShouldGenerateDisplayValues()
+   {
+      return shouldGenerateDisplayValues;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for shouldGenerateDisplayValues
+    **
+    *******************************************************************************/
+   public void setShouldGenerateDisplayValues(boolean shouldGenerateDisplayValues)
+   {
+      this.shouldGenerateDisplayValues = shouldGenerateDisplayValues;
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for transaction
+    **
+    *******************************************************************************/
+   public QBackendTransaction getTransaction()
+   {
+      return transaction;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for transaction
+    **
+    *******************************************************************************/
+   public void setTransaction(QBackendTransaction transaction)
+   {
+      this.transaction = transaction;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for transaction
+    **
+    *******************************************************************************/
+   public GetInput withTransaction(QBackendTransaction transaction)
+   {
+      this.transaction = transaction;
+      return (this);
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/tables/get/GetOutput.java

@@ -0,0 +1,72 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2022.  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 <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.model.actions.tables.get;
+
+
+import java.io.Serializable;
+import com.kingsrook.qqq.backend.core.model.actions.AbstractActionOutput;
+import com.kingsrook.qqq.backend.core.model.data.QRecord;
+
+
+/*******************************************************************************
+ ** Output for a Get action
+ **
+ *******************************************************************************/
+public class GetOutput extends AbstractActionOutput implements Serializable
+{
+   private QRecord record;
+
+
+
+   /*******************************************************************************
+    ** Getter for record
+    **
+    *******************************************************************************/
+   public QRecord getRecord()
+   {
+      return record;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for record
+    **
+    *******************************************************************************/
+   public void setRecord(QRecord record)
+   {
+      this.record = record;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for record
+    **
+    *******************************************************************************/
+   public GetOutput withRecord(QRecord record)
+   {
+      this.record = record;
+      return (this);
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/modules/backend/QBackendModuleInterface.java

@@ -24,6 +24,7 @@ package com.kingsrook.qqq.backend.core.modules.backend;
 
 import com.kingsrook.qqq.backend.core.actions.interfaces.CountInterface;
 import com.kingsrook.qqq.backend.core.actions.interfaces.DeleteInterface;
+import com.kingsrook.qqq.backend.core.actions.interfaces.GetInterface;
 import com.kingsrook.qqq.backend.core.actions.interfaces.InsertInterface;
 import com.kingsrook.qqq.backend.core.actions.interfaces.QueryInterface;
 import com.kingsrook.qqq.backend.core.actions.interfaces.UpdateInterface;
@@ -76,6 +77,15 @@ public interface QBackendModuleInterface
       return null;
    }
 
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   default GetInterface getGetInterface()
+   {
+      throwNotImplemented("Get");
+      return null;
+   }
+
    /*******************************************************************************
     **
     *******************************************************************************/

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/utils/JsonUtils.java

@@ -23,9 +23,9 @@ package com.kingsrook.qqq.backend.core.utils;
 
 
 import java.io.IOException;
-import java.time.LocalDateTime;
-import java.time.format.DateTimeFormatter;
-import java.time.format.DateTimeParseException;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -233,31 +233,54 @@ public class JsonUtils
    public static QRecord parseQRecord(JSONObject jsonObject, Map<String, QFieldMetaData> fields)
    {
       QRecord record = new QRecord();
+
+      FIELDS_LOOP:
       for(String fieldName : fields.keySet())
       {
          QFieldMetaData metaData    = fields.get(fieldName);
          String         backendName = metaData.getBackendName() != null ? metaData.getBackendName() : fieldName;
-         switch(metaData.getType())
+
+         /////////////////////////////////////////////////////////////////////////////////////////////////
+         // if the field backend name has dots in it, interpret that to mean traversal down sub-objects //
+         /////////////////////////////////////////////////////////////////////////////////////////////////
+         JSONObject jsonObjectToUse = jsonObject;
+         if(backendName.contains("."))
          {
-            case INTEGER -> record.setValue(fieldName, jsonObject.optInt(backendName));
-            case DECIMAL -> record.setValue(fieldName, jsonObject.optBigDecimal(backendName, null));
-            case BOOLEAN -> record.setValue(fieldName, jsonObject.optBoolean(backendName));
-            case DATE_TIME ->
+            ArrayList<String> levels = new ArrayList<>(List.of(backendName.split("\\.")));
+            backendName = levels.remove(levels.size() - 1);
+
+            for(String level : levels)
             {
-               String dateTimeString = jsonObject.optString(backendName);
-               if(StringUtils.hasContent(dateTimeString))
+               try
                {
-                  try
+                  jsonObjectToUse = jsonObjectToUse.optJSONObject(level);
+                  if(jsonObjectToUse == null)
                   {
-                     record.setValue(fieldName, LocalDateTime.parse(dateTimeString, DateTimeFormatter.ISO_ZONED_DATE_TIME));
-                  }
-                  catch(DateTimeParseException dtpe1)
-                  {
-                     record.setValue(fieldName, LocalDateTime.parse(dateTimeString, DateTimeFormatter.ISO_DATE_TIME));
+                     continue FIELDS_LOOP;
                   }
                }
+               catch(Exception e)
+               {
+                  continue FIELDS_LOOP;
+               }
             }
-            default -> record.setValue(fieldName, jsonObject.optString(backendName));
+         }
+
+         switch(metaData.getType())
+         {
+            case INTEGER -> record.setValue(fieldName, jsonObjectToUse.optInt(backendName));
+            case DECIMAL -> record.setValue(fieldName, jsonObjectToUse.optBigDecimal(backendName, null));
+            case BOOLEAN -> record.setValue(fieldName, jsonObjectToUse.optBoolean(backendName));
+            case DATE_TIME ->
+            {
+               String dateTimeString = jsonObjectToUse.optString(backendName);
+               if(StringUtils.hasContent(dateTimeString))
+               {
+                  Instant instant = ValueUtils.getValueAsInstant(dateTimeString);
+                  record.setValue(fieldName, instant);
+               }
+            }
+            default -> record.setValue(fieldName, jsonObjectToUse.optString(backendName));
          }
       }
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/utils/ValueUtils.java

@@ -30,6 +30,7 @@ import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.time.LocalTime;
 import java.time.ZoneId;
+import java.time.ZoneOffset;
 import java.time.format.DateTimeFormatter;
 import java.time.format.DateTimeParseException;
 import java.util.Calendar;
@@ -498,6 +499,22 @@ public class ValueUtils
       }
       else
       {
+         try
+         {
+            return LocalDateTime.parse(s, DateTimeFormatter.ISO_ZONED_DATE_TIME).toInstant(ZoneOffset.UTC);
+         }
+         catch(DateTimeParseException e2)
+         {
+            try
+            {
+               return LocalDateTime.parse(s, DateTimeFormatter.ISO_DATE_TIME).toInstant(ZoneOffset.UTC);
+            }
+            catch(Exception e3)
+            {
+               // just throw the original
+            }
+         }
+
          throw (e);
       }
    }