Package com.flowable.platform.common.form

Class FormPayloadHelper

  • public class FormPayloadHelper
extends java.lang.Object

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static java.lang.Object convertToContentItem​(java.lang.Object value, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static java.lang.String createBEExpression​(java.lang.String... variableNameParts)  
      protected static java.util.List<java.lang.Object> getFormDataModelListVariable​(java.lang.String submittedKey, com.flowable.form.model.FormDataModel formDataModel, java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> variables, java.util.Map<java.lang.String,​java.lang.Object> originalPayload, java.util.Map<java.lang.String,​java.util.List<com.flowable.form.engine.impl.util.FormVariable>> variableTypes, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static java.lang.Object getFormDataModelVariable​(java.lang.String submittedKey, com.flowable.form.model.FormDataModel formDataModel, java.util.Map<java.lang.String,​java.lang.Object> dataModelValues, java.util.Map<java.lang.String,​java.lang.Object> originalDataModelValues, java.util.Map<java.lang.String,​java.util.List<com.flowable.form.engine.impl.util.FormVariable>> variableTypes, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static java.util.List<com.flowable.form.engine.impl.util.FormVariable> getFormVariables​(java.lang.String submittedKey, java.lang.String childKey, java.util.Map<java.lang.String,​java.util.List<com.flowable.form.engine.impl.util.FormVariable>> variableTypes)  
      static java.util.Map<java.lang.String,​java.util.List<org.flowable.cmmn.model.ExtensionElement>> getPlanItemExtensionElements​(java.lang.String caseDefinitionId, java.lang.String planItemDefinitionId)  
      static java.lang.String getStartFormKey​(java.util.Map<java.lang.String,​java.util.List<org.flowable.cmmn.model.ExtensionElement>> extensionElements)  
      protected static com.flowable.form.engine.impl.util.FormVariable getVariableToApply​(java.util.List<com.flowable.form.engine.impl.util.FormVariable> variableTypes)
      Get the first prioritized variable type from the variableTypes if exists, or the first variable type from the list
      protected static boolean isListOfType​(java.lang.Object value, java.lang.Class<?> listElementClass)  
      static boolean isStartFormSameDeployment​(java.util.Map<java.lang.String,​java.util.List<org.flowable.cmmn.model.ExtensionElement>> extensionElements)  
      protected static void parseChildFormVariableList​(java.util.List<java.lang.Object> variableList, java.util.List<java.lang.String> parentVariableList, java.util.Map<java.lang.String,​java.lang.Object> originalPayload, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static void parseChildFormVariableMap​(java.util.Map<java.lang.String,​java.lang.Object> variableMap, java.util.List<java.lang.String> parentVariableList, java.util.Map<java.lang.String,​java.lang.Object> originalPayload, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      static java.util.Map<java.lang.String,​java.lang.Object> parseFormVariables​(java.util.Map<java.lang.String,​java.lang.Object> submittedValues, java.util.Map<java.lang.String,​java.lang.Object> originalPayload, com.flowable.form.model.FlowableFormModel formModel, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static java.util.List<org.flowable.content.api.ContentItem> retrieveContentItems​(com.flowable.core.content.api.CoreContentService contentService, java.util.Set<java.lang.String> contentItemIdSet, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> metadataMap)  
      protected static boolean skipVariable​(int childIndex, java.lang.Object variableValue, java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> originalListPayload)  
      protected static boolean skipVariable​(java.lang.String variableName, java.lang.Object variableValue, java.util.Map<java.lang.String,​java.lang.Object> originalPayload)  
      protected static boolean skipVariable​(java.lang.String variableName, java.lang.String childName, java.lang.Object variableValue, java.util.Map<java.lang.String,​java.lang.Object> originalPayload)  
      protected static boolean skipVariable​(java.util.List<java.lang.String> parentVariableNames, java.lang.String childName, java.lang.Object variableValue, java.util.Map<java.lang.String,​java.lang.Object> originalPayload)  
      protected static java.lang.Boolean transformAsBoolean​(java.lang.Object value)  
      protected static java.lang.Object transformAsDate​(java.lang.Object value)  
      protected static java.lang.Number transformAsNumber​(java.lang.Object value, java.lang.String subType)  
      protected static java.lang.Object transformAsPotentialJsonNode​(java.lang.Object value, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static java.lang.Object transformVariable​(java.lang.Object submittedValue, java.util.List<com.flowable.form.engine.impl.util.FormVariable> variableTypes, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  
      protected static void traverseVariableListForContentItems​(java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> valuesList, java.util.Set<java.lang.String> contentItemIdSet, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> metadataMap)  
      protected static void traverseVariableMapForContentItems​(java.util.Map<java.lang.String,​java.lang.Object> mapValue, java.util.Set<java.lang.String> contentItemIdSet, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> metadataMap)  
      static java.util.Map<java.lang.String,​java.lang.Object> validatePayload​(java.util.Map<java.lang.String,​java.lang.Object> submittedValues, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • BASE_EXPRESSION_KEYS

        protected static final java.util.Set<java.lang.String> BASE_EXPRESSION_KEYS

      • FE_EXPRESSION_END

        protected static final java.lang.String FE_EXPRESSION_END
        See Also:
        Constant Field Values

      • FE_EXPRESSION_START

        protected static final java.lang.String FE_EXPRESSION_START
        See Also:
        Constant Field Values

      • EXPRESSION_VARIABLE_DELIMITER

        protected static final java.lang.String EXPRESSION_VARIABLE_DELIMITER
        See Also:
        Constant Field Values

      • PRIORITIZED_VARIABLE_TYPES

        protected static final java.util.Collection<java.lang.String> PRIORITIZED_VARIABLE_TYPES

    • Constructor Detail

      • FormPayloadHelper

        public FormPayloadHelper()

    • Method Detail

      • validatePayload

        public static java.util.Map<java.lang.String,​java.lang.Object> validatePayload​(java.util.Map<java.lang.String,​java.lang.Object> submittedValues,
                                                                                     com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • parseFormVariables

        public static java.util.Map<java.lang.String,​java.lang.Object> parseFormVariables​(java.util.Map<java.lang.String,​java.lang.Object> submittedValues,
                                                                                        java.util.Map<java.lang.String,​java.lang.Object> originalPayload,
                                                                                        com.flowable.form.model.FlowableFormModel formModel,
                                                                                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • parseChildFormVariableMap

        protected static void parseChildFormVariableMap​(java.util.Map<java.lang.String,​java.lang.Object> variableMap,
                                                java.util.List<java.lang.String> parentVariableList,
                                                java.util.Map<java.lang.String,​java.lang.Object> originalPayload,
                                                com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • parseChildFormVariableList

        protected static void parseChildFormVariableList​(java.util.List<java.lang.Object> variableList,
                                                 java.util.List<java.lang.String> parentVariableList,
                                                 java.util.Map<java.lang.String,​java.lang.Object> originalPayload,
                                                 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • getFormDataModelListVariable

        protected static java.util.List<java.lang.Object> getFormDataModelListVariable​(java.lang.String submittedKey,
                                                                               com.flowable.form.model.FormDataModel formDataModel,
                                                                               java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> variables,
                                                                               java.util.Map<java.lang.String,​java.lang.Object> originalPayload,
                                                                               java.util.Map<java.lang.String,​java.util.List<com.flowable.form.engine.impl.util.FormVariable>> variableTypes,
                                                                               com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • getFormDataModelVariable

        protected static java.lang.Object getFormDataModelVariable​(java.lang.String submittedKey,
                                                           com.flowable.form.model.FormDataModel formDataModel,
                                                           java.util.Map<java.lang.String,​java.lang.Object> dataModelValues,
                                                           java.util.Map<java.lang.String,​java.lang.Object> originalDataModelValues,
                                                           java.util.Map<java.lang.String,​java.util.List<com.flowable.form.engine.impl.util.FormVariable>> variableTypes,
                                                           com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • getPlanItemExtensionElements

        public static java.util.Map<java.lang.String,​java.util.List<org.flowable.cmmn.model.ExtensionElement>> getPlanItemExtensionElements​(java.lang.String caseDefinitionId,
                                                                                                                                          java.lang.String planItemDefinitionId)

      • getStartFormKey

        public static java.lang.String getStartFormKey​(java.util.Map<java.lang.String,​java.util.List<org.flowable.cmmn.model.ExtensionElement>> extensionElements)

      • isStartFormSameDeployment

        public static boolean isStartFormSameDeployment​(java.util.Map<java.lang.String,​java.util.List<org.flowable.cmmn.model.ExtensionElement>> extensionElements)

      • createBEExpression

        protected static java.lang.String createBEExpression​(java.lang.String... variableNameParts)

      • convertToContentItem

        protected static java.lang.Object convertToContentItem​(java.lang.Object value,
                                                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • traverseVariableListForContentItems

        protected static void traverseVariableListForContentItems​(java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> valuesList,
                                                          java.util.Set<java.lang.String> contentItemIdSet,
                                                          java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> metadataMap)

      • traverseVariableMapForContentItems

        protected static void traverseVariableMapForContentItems​(java.util.Map<java.lang.String,​java.lang.Object> mapValue,
                                                         java.util.Set<java.lang.String> contentItemIdSet,
                                                         java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> metadataMap)

      • retrieveContentItems

        protected static java.util.List<org.flowable.content.api.ContentItem> retrieveContentItems​(com.flowable.core.content.api.CoreContentService contentService,
                                                                                           java.util.Set<java.lang.String> contentItemIdSet,
                                                                                           java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> metadataMap)

      • skipVariable

        protected static boolean skipVariable​(java.lang.String variableName,
                                      java.lang.Object variableValue,
                                      java.util.Map<java.lang.String,​java.lang.Object> originalPayload)

      • skipVariable

        protected static boolean skipVariable​(java.lang.String variableName,
                                      java.lang.String childName,
                                      java.lang.Object variableValue,
                                      java.util.Map<java.lang.String,​java.lang.Object> originalPayload)

      • skipVariable

        protected static boolean skipVariable​(java.util.List<java.lang.String> parentVariableNames,
                                      java.lang.String childName,
                                      java.lang.Object variableValue,
                                      java.util.Map<java.lang.String,​java.lang.Object> originalPayload)

      • skipVariable

        protected static boolean skipVariable​(int childIndex,
                                      java.lang.Object variableValue,
                                      java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> originalListPayload)

      • getFormVariables

        protected static java.util.List<com.flowable.form.engine.impl.util.FormVariable> getFormVariables​(java.lang.String submittedKey,
                                                                                                  java.lang.String childKey,
                                                                                                  java.util.Map<java.lang.String,​java.util.List<com.flowable.form.engine.impl.util.FormVariable>> variableTypes)

      • transformVariable

        protected static java.lang.Object transformVariable​(java.lang.Object submittedValue,
                                                    java.util.List<com.flowable.form.engine.impl.util.FormVariable> variableTypes,
                                                    com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • transformAsPotentialJsonNode

        protected static java.lang.Object transformAsPotentialJsonNode​(java.lang.Object value,
                                                               com.fasterxml.jackson.databind.ObjectMapper objectMapper)

      • getVariableToApply

        protected static com.flowable.form.engine.impl.util.FormVariable getVariableToApply​(java.util.List<com.flowable.form.engine.impl.util.FormVariable> variableTypes)
        Get the first prioritized variable type from the variableTypes if exists, or the first variable type from the list
        Parameters:
        variableTypes - list of variables
        Returns:
        variable which is applied on the value

      • transformAsBoolean

        protected static java.lang.Boolean transformAsBoolean​(java.lang.Object value)

      • transformAsDate

        protected static java.lang.Object transformAsDate​(java.lang.Object value)

      • transformAsNumber

        protected static java.lang.Number transformAsNumber​(java.lang.Object value,
                                                    java.lang.String subType)

      • isListOfType

        protected static boolean isListOfType​(java.lang.Object value,
                                      java.lang.Class<?> listElementClass)