src/main/java/org/onap/nbi/commons/JacksonFilter.java

   1 /**
   2  *     Copyright (c) 2018 Orange
   3  *
   4  *     Licensed under the Apache License, Version 2.0 (the "License");
   5  *     you may not use this file except in compliance with the License.
   6  *     You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *     Unless required by applicable law or agreed to in writing, software
  11  *     distributed under the License is distributed on an "AS IS" BASIS,
  12  *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *     See the License for the specific language governing permissions and
  14  *     limitations under the License.
  15  */
  16 package org.onap.nbi.commons;
  17
  18 import java.math.BigDecimal;
  19 import java.util.ArrayList;
  20 import java.util.Arrays;
  21 import java.util.Collection;
  22 import java.util.LinkedHashSet;
  23 import java.util.LinkedList;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Set;
  27 import org.springframework.util.LinkedMultiValueMap;
  28 import org.springframework.util.MultiValueMap;
  29 import com.fasterxml.jackson.databind.JsonNode;
  30 import com.fasterxml.jackson.databind.ObjectMapper;
  31 import com.fasterxml.jackson.databind.node.ArrayNode;
  32 import com.fasterxml.jackson.databind.node.ObjectNode;
  33
  34 public class JacksonFilter {
  35
  36     private final static List<String> SKIPPED_FIELDS = Arrays.asList("internalId");
  37
  38
  39     public static <R> List<ObjectNode> createNodes(List<R> list, JsonRepresentation jsonRepresentation) {
  40
  41         Set<R> set;
  42         if (list == null) {
  43             set = new LinkedHashSet<>();
  44         } else {
  45             set = new LinkedHashSet<>(list);
  46         }
  47         return createNodes(set, jsonRepresentation);
  48     }
  49
  50     public static <R> List<ObjectNode> createNodes(Collection<R> collection, JsonRepresentation jsonRepresentation) {
  51         List<ObjectNode> nodeList = new ArrayList<>();
  52         for (R element : collection) {
  53             ObjectNode node = createNode(element, jsonRepresentation);
  54             nodeList.add(node);
  55         }
  56         return nodeList;
  57     }
  58
  59     public static <R> ObjectNode createNode(R bean, JsonRepresentation jsonRepresentation) {
  60         ObjectMapper mapper = new ObjectMapper();
  61         return JacksonFilter.createNode(mapper, bean, jsonRepresentation.getAttributes());
  62     }
  63
  64     private static <R> ObjectNode createNode(ObjectMapper mapper, R bean, Set<String> names) {
  65         // split fieldNames in 2 categories :
  66         // simpleFields for simple property names with no '.'
  67         // nestedFields for nested property names with a '.'
  68         Set<String> simpleFields = new LinkedHashSet<String>();
  69         MultiValueMap nestedFields = new LinkedMultiValueMap();
  70         buildFields(names, simpleFields, nestedFields);
  71
  72         // create a simple node with only one level containing all simples
  73         // properties
  74         ObjectNode rootNode = JacksonFilter.createNodeWithSimpleFields(mapper, bean, simpleFields);
  75
  76         // create nested nodes with deeper levels
  77         Set<Map.Entry<String, List<String>>> entrySet = nestedFields.entrySet();
  78         // for each nested value, create recursively a node
  79         for (Map.Entry<String, List<String>> entry : entrySet) {
  80             String rootFieldName = entry.getKey();
  81             // add in current node only if full value is not already present in
  82             // 1st level
  83             if (!simpleFields.contains(rootFieldName)) {
  84                 Object nestedBean = BeanUtils.getNestedProperty(bean, rootFieldName);
  85                 // add only non null fields
  86                 if (nestedBean == null) {
  87                     continue;
  88                 }
  89                 Set<String> nestedFieldNames = new LinkedHashSet<String>(entry.getValue());
  90                 // current node is an array or a list
  91                 if ((nestedBean.getClass().isArray()) || (Collection.class.isAssignableFrom(nestedBean.getClass()))) {
  92                     handleListNode(mapper, rootNode, rootFieldName, nestedBean, nestedFieldNames);
  93                 } else {
  94                     // create recursively a node and add it in current root node
  95                     createNodeRecursively(mapper, rootNode, rootFieldName, nestedBean, nestedFieldNames);
  96                 }
  97             }
  98         }
  99         return rootNode;
 100     }
 101
 102     private static void createNodeRecursively(ObjectMapper mapper, ObjectNode rootNode, String rootFieldName,
 103             Object nestedBean, Set<String> nestedFieldNames) {
 104         ObjectNode nestedNode = JacksonFilter.createNode(mapper, nestedBean, nestedFieldNames);
 105         if ((nestedNode != null) && (nestedNode.size() > 0)) {
 106             rootNode.set(rootFieldName, nestedNode);
 107         }
 108     }
 109
 110     private static void buildFields(Set<String> names, Set<String> simpleFields, MultiValueMap nestedFields) {
 111         for (String name : names) {
 112             int index = name.indexOf('.');
 113             boolean isNestedField = (index > 0) && (index < name.length());
 114             if (isNestedField) {
 115                 String rootFieldName = name.substring(0, index);
 116                 String subFieldName = name.substring(index + 1);
 117                 nestedFields.add(rootFieldName, subFieldName);
 118             } else {
 119                 simpleFields.add(name);
 120             }
 121         }
 122     }
 123
 124     private static void handleListNode(ObjectMapper mapper, ObjectNode rootNode, String rootFieldName,
 125             Object nestedBean, Set<String> nestedFieldNames) {
 126         Object[] array = null;
 127         if ((nestedBean.getClass().isArray())) {
 128             array = (Object[]) nestedBean;
 129         } else {
 130             Collection<?> collection = (Collection<?>) nestedBean;
 131             array = collection.toArray();
 132         }
 133         if (array.length > 0) {
 134             // create a node for each element in array
 135             // and add created node in an arrayNode
 136             Collection<JsonNode> nodes = new LinkedList<JsonNode>();
 137             for (Object object : array) {
 138                 ObjectNode nestedNode = JacksonFilter.createNode(mapper, object, nestedFieldNames);
 139                 if ((nestedNode != null) && (nestedNode.size() > 0)) {
 140                     nodes.add(nestedNode);
 141                 }
 142             }
 143             ArrayNode arrayNode = mapper.createArrayNode();
 144             arrayNode.addAll(nodes);
 145             if (arrayNode.size() > 0) {
 146                 rootNode.set(rootFieldName, arrayNode);
 147             }
 148         }
 149     }
 150
 151     private static <R> ObjectNode createNodeWithSimpleFields(ObjectMapper mapper, R bean, Set<String> names) {
 152         ObjectNode node = mapper.createObjectNode();
 153         for (String name : names) {
 154             // Prevent getting value of some fields
 155             if (SKIPPED_FIELDS.contains(name)) {
 156                 continue;
 157             }
 158
 159             JacksonFilter.nodePut(node, name, BeanUtils.getNestedProperty(bean, name));
 160         }
 161         return node;
 162     }
 163
 164     private static void nodePut(ObjectNode node, String name, Object value) {
 165         if (value instanceof Boolean) {
 166             node.put(name, (Boolean) value);
 167         } else if (value instanceof Integer) {
 168             node.put(name, (Integer) value);
 169         } else if (value instanceof Long) {
 170             node.put(name, (Long) value);
 171         } else if (value instanceof Float) {
 172             node.put(name, (Float) value);
 173         } else if (value instanceof Double) {
 174             node.put(name, (Double) value);
 175         } else if (value instanceof BigDecimal) {
 176             node.put(name, (BigDecimal) value);
 177         } else if (value instanceof String) {
 178             node.put(name, (String) value);
 179         } else {
 180             node.putPOJO(name, value);
 181         }
 182     }
 183
 184 }