1 /***********************************************************************
2  * Copyright (c) 2013-2024 Commonwealth Computer Research, Inc.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Apache License, Version 2.0
5  * which accompanies this distribution and is available at
6  * http://www.opensource.org/licenses/apache2.0.php.
7  ***********************************************************************/
8 
9 package org.locationtech.geomesa.utils.geotools
10 
11 import org.geotools.api.feature.`type`.AttributeDescriptor
12 import org.geotools.api.feature.simple.SimpleFeatureType
13 import org.locationtech.geomesa.utils.io.WithClose
14 
15 import java.io.{File, FileWriter, Writer}
16 
17 object GenerateRichFeatureModels {
18 
19   /**
20    * Creates implicit wrappers for any typesafe config format files found under src/main/resources
21    *
22    * @param args (0) - base directory for the maven project
23    *             (1) - package to place the implicit classes
24    */
25   def main(args: Array[String]): Unit = {
26     val basedir = args(0)
27     val packageName = args(1)
28     assert(basedir != null)
29     assert(packageName != null)
30 
31     val sfts = SimpleFeatureTypeLoader.sfts
32 
33     if (sfts.isEmpty) {
34       println("No formats found")
35     } else {
36       sfts.foreach { sft =>
37         val name = s"${safeIdentifier(sft.getTypeName)}Model"
38         val classFilePath = s"$basedir/src/main/scala/${packageName.replaceAll("\\.", "/")}/$name.scala"
39         val classFile = new File(classFilePath)
40         println(s"Writing class file $packageName.$name with feature type ${sft.getTypeName}")
41         WithClose(new FileWriter(classFile)) { fw =>
42           buildSingleClass(sft, name, packageName, fw)
43         }
44       }
45     }
46   }
47 
48   def buildSingleClass(sft: SimpleFeatureType, name: String, pkg: String, out: Writer): Unit = {
49     out.append(s"package $pkg\n\n")
50     out.append("import org.geotools.api.feature.simple.SimpleFeature\n\n")
51     out.append(s"// this class was generated by ${GenerateRichFeatureModels.getClass.getName} for feature type ${sft.getTypeName}\n")
52     out.append(s"object $name {\n\n")
53     out.append(s"  implicit class RichFeature(val sf: SimpleFeature) extends AnyVal {\n")
54     var i = 0
55     while (i < sft.getAttributeCount) {
56       val attr = AttributeMethods(sft, i)
57       out.append("\n")
58       out.append(s"    ${attr.getter}\n")
59       out.append(s"    ${attr.optionGetter}\n")
60       out.append(s"    ${attr.setter}\n")
61       i += 1
62     }
63     out.append(
64       s"""
65          |    def debug(): String = {
66          |      import scala.collection.JavaConverters._
67          |      val sb = new StringBuilder(s"$${sf.getType.getTypeName}:$${sf.getID}")
68          |      sf.getProperties.asScala.foreach(p => sb.append(s"|$${p.getName.getLocalPart}=$${p.getValue}"))
69          |      sb.toString()
70          |    }
71          |""".stripMargin)
72     out.append("  }\n}")
73   }
74 
75   private[geotools] def getAttributeBinding(descriptor: AttributeDescriptor): String = {
76     import org.locationtech.geomesa.utils.geotools.RichAttributeDescriptors._
77 
78     def subtype(c: Class[_]): String = c match {
79       case null => "String"
80       case c => c.getCanonicalName
81     }
82 
83     val binding = descriptor.getType.getBinding.getCanonicalName
84     if (descriptor.isList) {
85       s"$binding[${subtype(descriptor.getListType())}]"
86     } else if (descriptor.isMap) {
87       val (keyType, valueType) = descriptor.getMapTypes()
88       s"$binding[${subtype(keyType)},${subtype(valueType)}]"
89     } else {
90       binding
91     }
92   }
93 
94   private def safeIdentifier(name: String): String = {
95     val safe = new StringBuilder()
96     var i = 0
97     var upper = true // camel case
98     while (i < name.length) {
99       val char = name.charAt(i)
100       if (char == '_'||
101           (i == 0 && !Character.isJavaIdentifierStart(char)) ||
102           (i != 0 && !Character.isJavaIdentifierPart(char))) {
103         upper = true
104       } else if (upper) {
105         safe.append(char.toUpper)
106         upper = false
107       } else {
108         safe.append(char)
109       }
110       i += 1
111     }
112     if (safe.isEmpty) {
113       throw new IllegalArgumentException(s"Can't create valid Java identifier from $name")
114     }
115     safe.toString
116   }
117 
118   private class AttributeMethods(name: String, index: Int, clazz: String) {
119     def getter: String = s"def get$name: $clazz = sf.getAttribute($index).asInstanceOf[$clazz]"
120     def optionGetter: String = s"def opt$name: Option[$clazz] = Option(get$name)"
121     def setter: String = s"def set$name(x: $clazz): Unit = sf.setAttribute($index, x)"
122   }
123 
124   private object AttributeMethods {
125     def apply(sft: SimpleFeatureType, i: Int): AttributeMethods = {
126       val descriptor = sft.getDescriptor(i)
127       val binding = getAttributeBinding(descriptor)
128       new AttributeMethods(safeIdentifier(descriptor.getLocalName), i, binding)
129     }
130   }
131 }