#164: Added payloads support (#173)

Co-authored-by: darnjo <josh@reso.org>

src/main/java/org/reso/certification/codegen/EDMXProcessor.java

@@ -4,7 +4,6 @@
 import org.apache.logging.log4j.Logger;
 import org.reso.commander.common.Utils;
 import org.reso.models.ReferenceStandardField;
-import org.reso.models.ReferenceStandardLookup;
 import org.w3c.dom.Document;
 import org.w3c.dom.bootstrap.DOMImplementationRegistry;
 import org.w3c.dom.ls.DOMImplementationLS;
@@ -20,7 +19,6 @@
 import java.util.Map;
 
 import static org.reso.commander.common.DataDictionaryMetadata.getKeyFieldForResource;
-import static org.reso.commander.common.Utils.wrapColumns;
 
 //TODO: switch to build an XML document rather than creating it as a string
 public class EDMXProcessor extends WorksheetProcessor {
@@ -115,7 +113,8 @@ void processExpansion(ReferenceStandardField field) {
 
     content.append(EDMXTemplates.buildDisplayNameAnnotation(field.getDisplayName()))
         .append(EDMXTemplates.buildDDWikiUrlAnnotation(field.getWikiPageUrl()))
-        .append(EDMXTemplates.buildDescriptionAnnotation(field.getDefinition()));
+        .append(EDMXTemplates.buildDescriptionAnnotation(field.getDefinition()))
+        .append(EDMXTemplates.buildPayloadsAnnotation(String.join(",", field.getPayloads())));
 
     content.append("</NavigationProperty>");
 
@@ -276,38 +275,43 @@ private String buildMultipleEnumTypeMarkup(ReferenceStandardField standardField)
 
   public static final class EDMXTemplates {
     public static String buildDisplayNameAnnotation(String content) {
-      if (content == null || content.length() == 0) return EMPTY_STRING;
+      if (content == null || content.isEmpty()) return EMPTY_STRING;
       return String.format("<Annotation Term=\"RESO.OData.Metadata.StandardName\" String=\"%1$s\" />", sanitizeXml(content));
     }
 
+    public static String buildPayloadsAnnotation(String content) {
+      if (content == null || content.isEmpty()) return EMPTY_STRING;
+      return String.format("<Annotation Term=\"RESO.OData.Metadata.Payloads\" String=\"%1$s\" />", sanitizeXml(content));
+    }
+
     //wrapColumns(referenceStandardField.getDefinition().replaceAll("--", "-"), "   ")
     public static String buildDescriptionAnnotation(String content) {
-      if (content == null || content.length() == 0) return EMPTY_STRING;
+      if (content == null || content.isEmpty()) return EMPTY_STRING;
       return String.format("<Annotation Term=\"Core.Description\" String=\"%1$s\" />", sanitizeXml(content));
     }
 
     public static String buildDDWikiUrlAnnotation(String content) {
-      if (content == null || content.length() == 0) return EMPTY_STRING;
+      if (content == null || content.isEmpty()) return EMPTY_STRING;
       return String.format("<Annotation Term=\"RESO.DDWikiUrl\" String=\"%1$s\" />", sanitizeXml(content));
     }
 
     public static String buildBooleanMember(ReferenceStandardField field) {
       if (field == null) return EMPTY_STRING;
-      return ""
-          + "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Boolean\" >"
+      return "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Boolean\" >"
           + buildDisplayNameAnnotation(field.getDisplayName())
           + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
           + buildDescriptionAnnotation(field.getDefinition())
+          + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
           + "</Property>";
     }
 
     public static String buildDateMember(ReferenceStandardField field) {
       if (field == null) return EMPTY_STRING;
-      return ""
-          + "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Date\" >"
+      return "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Date\" >"
           + buildDisplayNameAnnotation(field.getDisplayName())
           + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
           + buildDescriptionAnnotation(field.getDefinition())
+          + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
           + "</Property>";
     }
 
@@ -319,8 +323,7 @@ public static String buildNumberMember(ReferenceStandardField field) {
 
     public static String buildDecimalMember(ReferenceStandardField field) {
       if (field == null) return EMPTY_STRING;
-      String template = ""
-          + "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Decimal\"";
+      String template = "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Decimal\"";
 
       //DD uses length as precision in this case
       if (field.getSuggestedMaxLength() != null) template += " Precision=\"" + field.getSuggestedMaxLength() + "\"";
@@ -332,52 +335,54 @@ public static String buildDecimalMember(ReferenceStandardField field) {
           + buildDisplayNameAnnotation(field.getDisplayName())
           + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
           + buildDescriptionAnnotation(field.getDefinition())
+          + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
           + "</Property>";
 
       return template;
     }
 
     public static String buildIntegerMember(ReferenceStandardField field) {
       if (field == null) return EMPTY_STRING;
-      return ""
-          + "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Int64\" >"
+      return "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.Int64\" >"
           + buildDisplayNameAnnotation(field.getDisplayName())
           + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
           + buildDescriptionAnnotation(field.getDefinition())
+          + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
           + "</Property>";
     }
 
     public static String buildEnumTypeSingleMember(ReferenceStandardField field) {
       if (field == null || field.getLookupName() == null) return EMPTY_STRING;
-      if (field.getLookupName().trim().length() == 0) return EMPTY_STRING;
+      if (field.getLookupName().trim().isEmpty()) return EMPTY_STRING;
 
       return
           "<Property Name=\"" + field.getStandardName()
               + "\" Type=\"" + RESO_NAMESPACE + ".enums." + field.getLookupName() + "\" >"
               + buildDisplayNameAnnotation(field.getDisplayName())
               + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
               + buildDescriptionAnnotation(field.getDefinition())
+              + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
               + "</Property>";
     }
 
     public static String buildEnumTypeMultiMember(ReferenceStandardField field) {
       if (field == null || field.getLookupName() == null) return EMPTY_STRING;
-      if (field.getLookupName().trim().length() == 0) return EMPTY_STRING;
+      if (field.getLookupName().trim().isEmpty()) return EMPTY_STRING;
 
       return
           "<Property Name=\"" + field.getStandardName()
               + "\" Type=\"Collection(" + RESO_NAMESPACE + ".enums." + field.getLookupName() + ")\">"
               + buildDisplayNameAnnotation(field.getDisplayName())
               + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
               + buildDescriptionAnnotation(field.getDefinition())
+              + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
               + "</Property>";
 
     }
 
     public static String buildStringMember(ReferenceStandardField field) {
       if (field == null) return EMPTY_STRING;
-      String template = ""
-          + "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.String\"";
+      String template = "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.String\"";
 
       if (field.getSuggestedMaxLength() != null) template += " MaxLength=\"" + field.getSuggestedMaxLength() + "\"";
       template += " >";
@@ -386,15 +391,15 @@ public static String buildStringMember(ReferenceStandardField field) {
           buildDisplayNameAnnotation(field.getDisplayName())
               + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
               + buildDescriptionAnnotation(field.getDefinition())
+              + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
               + "</Property>";
 
       return template;
     }
 
     public static String buildDateTimeWithOffsetMember(ReferenceStandardField field) {
       if (field == null) return EMPTY_STRING;
-      String template = ""
-          + "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.DateTimeOffset\"";
+      String template = "<Property Name=\"" + field.getStandardName() + "\" Type=\"Edm.DateTimeOffset\"";
 
       if (field.getSuggestedMaxLength() != null) template += " Precision=\"" + field.getSuggestedMaxLength() + "\"";
       template += " >";
@@ -403,28 +408,10 @@ public static String buildDateTimeWithOffsetMember(ReferenceStandardField field)
           buildDisplayNameAnnotation(field.getDisplayName())
               + buildDDWikiUrlAnnotation(field.getWikiPageUrl())
               + buildDescriptionAnnotation(field.getDefinition())
+              + buildPayloadsAnnotation(String.join(",", field.getPayloads()))
               + "</Property>";
       return template;
     }
 
-    public static String buildComments(ReferenceStandardField referenceStandardField) {
-      if (referenceStandardField == null || referenceStandardField.getDefinition() == null || referenceStandardField.getDefinition().length() == 0)
-        return EMPTY_STRING;
-
-      //break every COLUMN_WIDTH characters only at word boundaries
-      return (referenceStandardField.getWikiPageUrl() != null && referenceStandardField.getWikiPageUrl().length() > 0 ?
-          " <!-- " + referenceStandardField.getWikiPageUrl() : "")
-          + " -->";
-    }
-
-    public static String buildComments(ReferenceStandardLookup referenceStandardLookup) {
-      if (referenceStandardLookup == null || referenceStandardLookup.getDefinition() == null || referenceStandardLookup.getDefinition().length() == 0)
-        return EMPTY_STRING;
-
-      //break every COLUMN_WIDTH characters only at word boundaries
-      return (referenceStandardLookup.getWikiPageUrl() != null && referenceStandardLookup.getWikiPageUrl().length() > 0 ? " <!-- " + referenceStandardLookup.getWikiPageUrl() : "") +
-          wrapColumns(referenceStandardLookup.getDefinition().replaceAll("--", "-"), "   ")
-          + " -->";
-    }
   }
 }

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/contactlistingnotes.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: ContactListingNotes
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/contactlistings.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: ContactListings
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/contacts.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Contacts
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/field.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Field
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/historytransactional.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: HistoryTransactional
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/internettracking.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: InternetTracking
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/lookup.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Lookup
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/media.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Media
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/member.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Member
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/office.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Office
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/openhouse.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: OpenHouse
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/otherphone.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: OtherPhone
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/ouid.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: OUID
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/property.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Property
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/propertygreenverification.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: PropertyGreenVerification
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/propertypowerproduction.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: PropertyPowerProduction
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/propertyrooms.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: PropertyRooms
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/propertyunittypes.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: PropertyUnitTypes
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/prospecting.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Prospecting
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/queue.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Queue
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/rules.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Rules
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/savedsearch.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: SavedSearch
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/showing.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Showing
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/socialmedia.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: SocialMedia
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/teammembers.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: TeamMembers
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v1.7/resource-tests/teams.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108150315330
+# This file was autogenerated on: 2023110900245888
 Feature: Teams
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/association.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: Association
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/caravan.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: Caravan
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/caravanstop.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: CaravanStop
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/contactlistingnotes.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: ContactListingNotes
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/contactlistings.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: ContactListings
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/contacts.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: Contacts
 
   Background:

src/main/java/org/reso/certification/features/data-dictionary/v2.0/resource-tests/entityevent.feature

@@ -1,4 +1,4 @@
-# This file was autogenerated on: 20231108152427929
+# This file was autogenerated on: 20231109002504917
 Feature: EntityEvent
 
   Background: