src/main/java/org/onap/aai/sa/searchdbabstraction/util/DocumentSchemaUtil.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.sa.searchdbabstraction.util;
  22
  23 import com.fasterxml.jackson.databind.ObjectMapper;
  24 import java.io.File;
  25 import java.io.FileInputStream;
  26 import java.io.IOException;
  27 import java.util.List;
  28 import java.util.concurrent.atomic.AtomicBoolean;
  29 import org.apache.commons.io.IOUtils;
  30 import org.onap.aai.sa.rest.DocumentFieldSchema;
  31 import org.onap.aai.sa.rest.DocumentSchema;
  32
  33 public class DocumentSchemaUtil {
  34
  35     private DocumentSchemaUtil() { // Do not instantiate
  36     }
  37
  38     private static String dynamicCustomMapping = null;
  39     private static final String DYNAMIC_CUSTOM_TEMPALTE_FILE =
  40             System.getProperty("CONFIG_HOME") + File.separator + "dynamic-custom-template.json";
  41
  42     public static String generateDocumentMappings(String documentSchema) throws IOException {
  43
  44         // Unmarshal the json content into a document schema object.
  45         ObjectMapper mapper = new ObjectMapper();
  46         DocumentSchema schema = mapper.readValue(documentSchema, DocumentSchema.class);
  47
  48         return generateDocumentMappings(schema);
  49     }
  50
  51     public static String generateDocumentMappings(DocumentSchema schema) throws IOException {
  52
  53         // Adding dynamic template to add fielddata=true to dynamic fields of type "string"
  54         // in order to avoid aggregation queries breaking in ESv6.1.2
  55         if (dynamicCustomMapping == null) {
  56             try {
  57                 dynamicCustomMapping = IOUtils.toString(new FileInputStream(DYNAMIC_CUSTOM_TEMPALTE_FILE), "UTF-8")
  58                         .replaceAll("\\s+", "");
  59             } catch (IOException e) {
  60                 throw new IOException(
  61                         "Dynamic Custom template configuration went wrong! Please check for the correct template file.",
  62                         e);
  63             }
  64         }
  65
  66         // Now, generate the Elastic Search mapping json and return it.
  67         StringBuilder sb = new StringBuilder();
  68         sb.append("{");
  69         // Adding custom mapping which adds fielddata=true to dynamic fields of type "string"
  70         sb.append(dynamicCustomMapping != null ? dynamicCustomMapping : "");
  71         sb.append("\"properties\": {");
  72
  73         generateFieldMappings(schema.getFields(), sb);
  74
  75         sb.append("}");
  76         sb.append("}");
  77
  78         return sb.toString();
  79     }
  80
  81
  82     private static void generateFieldMappings(List<DocumentFieldSchema> fields, StringBuilder sb) {
  83
  84         AtomicBoolean firstField = new AtomicBoolean(true);
  85
  86         for (DocumentFieldSchema field : fields) {
  87
  88             // If this isn't the first field in the list, prepend it with a ','
  89             if (!firstField.compareAndSet(true, false)) {
  90                 sb.append(", ");
  91             }
  92
  93             // Now, append the translated field contents.
  94             generateFieldMapping(field, sb);
  95         }
  96     }
  97
  98     private static void generateFieldMapping(DocumentFieldSchema fieldSchema, StringBuilder sb) {
  99
 100         sb.append("\"").append(fieldSchema.getName()).append("\": {");
 101
 102         // The field type is mandatory.
 103         sb.append("\"type\": \"").append(fieldSchema.getDataType()).append("\"");
 104
 105         // For date type fields we may optionally supply a format specifier.
 106         if (fieldSchema.getDataType().equals("date") && fieldSchema.getFormat() != null) {
 107             sb.append(", \"format\": \"").append(fieldSchema.getFormat()).append("\"");
 108         }
 109
 110         // If the index field was specified, then append it.
 111         if (fieldSchema.getSearchable() != null) {
 112             sb.append(", \"index\": \"").append(fieldSchema.getSearchable() ? "analyzed" : "not_analyzed").append("\"");
 113         }
 114
 115         // If a search analyzer was specified, then append it.
 116         if (fieldSchema.getSearchAnalyzer() != null) {
 117             sb.append(", \"search_analyzer\": \"").append(fieldSchema.getSearchAnalyzer()).append("\"");
 118         }
 119
 120         // If an indexing analyzer was specified, then append it.
 121         if (fieldSchema.getIndexAnalyzer() != null) {
 122             sb.append(", \"analyzer\": \"").append(fieldSchema.getIndexAnalyzer()).append("\"");
 123         }
 124
 125
 126         if (fieldSchema.getDataType().equals("nested")) {
 127
 128             sb.append(", \"properties\": {");
 129             generateFieldMappings(fieldSchema.getSubFields(), sb);
 130             sb.append("}");
 131         }
 132
 133         sb.append("}");
 134     }
 135
 136 }
 137