From 0f2555131802bbd644d55b547a1bc9a8b88dd43b Mon Sep 17 00:00:00 2001
From: "Barry M. Caceres" <barrycaceres@icloud.com>
Date: Wed, 2 Oct 2024 21:48:21 -0700
Subject: [PATCH] Added new flags pertaining to record-level features and made
 related updates

---
 src/main/java/com/senzing/sdk/SzFlag.java     | 68 +++++++++++++++++--
 .../com/senzing/sdk/SzFlagUsageGroup.java     | 15 ++--
 src/main/java/com/senzing/sdk/SzFlags.java    | 19 +++++-
 .../com/senzing/sdk/core/NativeEngine.java    | 12 +++-
 .../sdk/core/SzCoreDiagnosticTest.java        |  2 +-
 .../senzing/sdk/core/SzCoreEngineHowTest.java |  6 +-
 6 files changed, 102 insertions(+), 20 deletions(-)

diff --git a/src/main/java/com/senzing/sdk/SzFlag.java b/src/main/java/com/senzing/sdk/SzFlag.java
index 4caa49e..d6e37a7 100644
--- a/src/main/java/com/senzing/sdk/SzFlag.java
+++ b/src/main/java/com/senzing/sdk/SzFlag.java
@@ -350,7 +350,8 @@ public enum SzFlag {
         SzFlags.SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA, SZ_ENTITY_RECORD_SET),
 
     /**
-     * The value for the features identifiers for the records.
+     * The value for including features identifiers in the records
+     * segment, referencing back to the entity features.
      * <p>
      * This flag belongs to the following usage groups:
      * <ul>
@@ -364,8 +365,54 @@ public enum SzFlag {
      * </ul>
      * @see <a href="https://docs.senzing.com/flags/index.html">https://docs.senzing.com/flags/index.html</a>
      */
-    SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS(
-        SzFlags.SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS, SZ_ENTITY_SET),
+    SZ_ENTITY_INCLUDE_RECORD_FEATURES(
+        SzFlags.SZ_ENTITY_INCLUDE_RECORD_FEATURES, SZ_ENTITY_SET),
+
+    /**
+     * The value for including record-level feature details in
+     * the record segment of an entity or in a record response.
+     * This is affected by {@link 
+     * #SZ_ENTITY_INCLUDE_INTERNAL_FEATURES}.
+     * <p>
+     * This flag belongs to the following usage groups:
+     * <ul>
+     *    <li>{@link SzFlagUsageGroup#SZ_RECORD} 
+     *    <li>{@link SzFlagUsageGroup#SZ_ENTITY} 
+     *    <li>{@link SzFlagUsageGroup#SZ_SEARCH} 
+     *    <li>{@link SzFlagUsageGroup#SZ_EXPORT} 
+     *    <li>{@link SzFlagUsageGroup#SZ_FIND_PATH} 
+     *    <li>{@link SzFlagUsageGroup#SZ_FIND_NETWORK} 
+     *    <li>{@link SzFlagUsageGroup#SZ_WHY}
+     *    <li>{@link SzFlagUsageGroup#SZ_VIRTUAL_ENTITY}
+     * </ul>
+     * @see <a href="https://docs.senzing.com/flags/index.html">https://docs.senzing.com/flags/index.html</a>
+     */
+    SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS(
+        SzFlags.SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS, 
+        SZ_ENTITY_RECORD_SET),
+
+    /**
+     * The value for including record-level feature statistics
+     * in the record segment of an entity or in a record
+     * response.  This is affected by {@link 
+     * #SZ_ENTITY_INCLUDE_INTERNAL_FEATURES}.
+     * <p>
+     * This flag belongs to the following usage groups:
+     * <ul>
+     *    <li>{@link SzFlagUsageGroup#SZ_RECORD} 
+     *    <li>{@link SzFlagUsageGroup#SZ_ENTITY} 
+     *    <li>{@link SzFlagUsageGroup#SZ_SEARCH} 
+     *    <li>{@link SzFlagUsageGroup#SZ_EXPORT} 
+     *    <li>{@link SzFlagUsageGroup#SZ_FIND_PATH} 
+     *    <li>{@link SzFlagUsageGroup#SZ_FIND_NETWORK} 
+     *    <li>{@link SzFlagUsageGroup#SZ_WHY}
+     *    <li>{@link SzFlagUsageGroup#SZ_VIRTUAL_ENTITY}
+     * </ul>
+     * @see <a href="https://docs.senzing.com/flags/index.html">https://docs.senzing.com/flags/index.html</a>
+     */
+    SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS(
+        SzFlags.SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS, 
+        SZ_ENTITY_RECORD_SET),
 
     /**
      * The value for including the name of the related entities.
@@ -459,6 +506,7 @@ public enum SzFlag {
      * <p>
      * This flag belongs to the following usage groups:
      * <ul>
+     *    <li>{@link SzFlagUsageGroup#SZ_RECORD} 
      *    <li>{@link SzFlagUsageGroup#SZ_ENTITY} 
      *    <li>{@link SzFlagUsageGroup#SZ_SEARCH} 
      *    <li>{@link SzFlagUsageGroup#SZ_EXPORT} 
@@ -470,7 +518,8 @@ public enum SzFlag {
      * @see <a href="https://docs.senzing.com/flags/index.html">https://docs.senzing.com/flags/index.html</a>
      */
     SZ_ENTITY_INCLUDE_INTERNAL_FEATURES(
-        SzFlags.SZ_ENTITY_INCLUDE_INTERNAL_FEATURES, SZ_ENTITY_SET),
+        SzFlags.SZ_ENTITY_INCLUDE_INTERNAL_FEATURES, 
+        SZ_ENTITY_RECORD_SET),
 
     /**
      * The value for including feature statistics in entity output.
@@ -668,7 +717,10 @@ public enum SzFlag {
      */
     public static final Set<SzFlag> SZ_RECORD_ALL_FLAGS
         = Collections.unmodifiableSet(EnumSet.of(
+            SZ_ENTITY_INCLUDE_INTERNAL_FEATURES,
             SZ_ENTITY_INCLUDE_RECORD_TYPES,
+            SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS,
+            SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS,
             SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO,
             SZ_ENTITY_INCLUDE_RECORD_JSON_DATA,
             SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA));
@@ -697,7 +749,9 @@ public enum SzFlag {
         flagSet.add(SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO);
         flagSet.add(SZ_ENTITY_INCLUDE_RECORD_JSON_DATA);
         flagSet.add(SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA);
-        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS);
+        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURES);
+        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS);
+        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS);
         flagSet.add(SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME);
         flagSet.add(SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO);
         flagSet.add(SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY);
@@ -836,7 +890,9 @@ public enum SzFlag {
         flagSet.add(SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO);
         flagSet.add(SZ_ENTITY_INCLUDE_RECORD_JSON_DATA);
         flagSet.add(SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA);
-        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS);
+        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURES);
+        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS);
+        flagSet.add(SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS);
         flagSet.add(SZ_ENTITY_INCLUDE_INTERNAL_FEATURES);
         flagSet.add(SZ_ENTITY_INCLUDE_FEATURE_STATS);
         flagSet.add(SZ_ENTITY_INCLUDE_FEATURE_ELEMENTS);
diff --git a/src/main/java/com/senzing/sdk/SzFlagUsageGroup.java b/src/main/java/com/senzing/sdk/SzFlagUsageGroup.java
index 8275b23..43323d7 100644
--- a/src/main/java/com/senzing/sdk/SzFlagUsageGroup.java
+++ b/src/main/java/com/senzing/sdk/SzFlagUsageGroup.java
@@ -31,6 +31,7 @@ public enum SzFlagUsageGroup {
      * <p>
      * The {@link SzFlag} instances included in this usage group are:
      * <ul>
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_INTERNAL_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_TYPES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
@@ -64,7 +65,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY}
@@ -113,7 +114,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY}
@@ -166,7 +167,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY}
@@ -218,7 +219,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY}
@@ -280,7 +281,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY}
@@ -337,7 +338,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY}
@@ -420,7 +421,7 @@ public enum SzFlagUsageGroup {
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_JSON_DATA}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA}
-     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS}
+     *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_RECORD_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_INTERNAL_FEATURES}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_FEATURE_STATS}
      *      <li>{@link SzFlag#SZ_ENTITY_INCLUDE_FEATURE_ELEMENTS}
diff --git a/src/main/java/com/senzing/sdk/SzFlags.java b/src/main/java/com/senzing/sdk/SzFlags.java
index c252b75..7d90382 100644
--- a/src/main/java/com/senzing/sdk/SzFlags.java
+++ b/src/main/java/com/senzing/sdk/SzFlags.java
@@ -178,11 +178,26 @@ private SzFlags() {
         = (1L << 31);
 
     /**
-     * The bitwise flag for the features identifiers for the records.
+     * The bitwise flag to include the features identifiers at the
+     * record level, referencing the entity features.
      */
-    public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS
+    public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURES
         = (1L << 18);
 
+    /**
+     * The bitwise flag for including full feature details at the
+     * record level of an entity response or in a record response.
+     */
+    public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS
+        = (1L << 35);
+
+    /**
+     * The bitwise flag for including full feature statistics at the
+     * record level of an entity response or in a record response.
+     */
+    public static final long SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS
+        = (1L << 36);
+
     /**
      * The bitwise flag for including the name of the related entities.
      */
diff --git a/src/main/java/com/senzing/sdk/core/NativeEngine.java b/src/main/java/com/senzing/sdk/core/NativeEngine.java
index da8f087..65a51ed 100644
--- a/src/main/java/com/senzing/sdk/core/NativeEngine.java
+++ b/src/main/java/com/senzing/sdk/core/NativeEngine.java
@@ -145,7 +145,17 @@ interface NativeEngine extends NativeApi
     /**
      * The bitwise flag for the features identifiers for the records.
      */
-    long SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS = (1L << 18);
+    long SZ_ENTITY_INCLUDE_RECORD_FEATURES = (1L << 18);
+
+    /**
+     * The bitwise flag for getting feature details for records.
+     */
+    long SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS = (1L << 35);
+
+    /**
+     * The bitwise flag for getting feature stats for records.
+     */
+    long SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS = (1L << 36);
 
     /**
      * The bitwise flag for including the name of the related entities.
diff --git a/src/test/java/com/senzing/sdk/core/SzCoreDiagnosticTest.java b/src/test/java/com/senzing/sdk/core/SzCoreDiagnosticTest.java
index cc9823b..1d80f24 100644
--- a/src/test/java/com/senzing/sdk/core/SzCoreDiagnosticTest.java
+++ b/src/test/java/com/senzing/sdk/core/SzCoreDiagnosticTest.java
@@ -54,7 +54,7 @@ public class SzCoreDiagnosticTest extends AbstractTest {
         | SZ_ENTITY_INCLUDE_RECORD_JSON_DATA
         | SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
         | SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA
-        | SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS
+        | SZ_ENTITY_INCLUDE_RECORD_FEATURES
         | SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
         | SZ_ENTITY_INCLUDE_FEATURE_ELEMENTS
         | SZ_INCLUDE_MATCH_KEY_DETAILS
diff --git a/src/test/java/com/senzing/sdk/core/SzCoreEngineHowTest.java b/src/test/java/com/senzing/sdk/core/SzCoreEngineHowTest.java
index a703644..8387b09 100644
--- a/src/test/java/com/senzing/sdk/core/SzCoreEngineHowTest.java
+++ b/src/test/java/com/senzing/sdk/core/SzCoreEngineHowTest.java
@@ -96,7 +96,7 @@ public class SzCoreEngineHowTest extends AbstractTest {
     private static final Set<SzFlag> RECORD_FLAGS
         = Collections.unmodifiableSet(EnumSet.of(
             SZ_ENTITY_INCLUDE_RECORD_DATA,
-            SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS));
+            SZ_ENTITY_INCLUDE_RECORD_FEATURES));
     
     private static final List<Set<SzFlag>> VIRTUAL_ENTITY_FLAG_SETS;
     static {
@@ -106,14 +106,14 @@ public class SzCoreEngineHowTest extends AbstractTest {
         list.add(SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS);
         list.add(SZ_VIRTUAL_ENTITY_ALL_FLAGS);
         list.add(Collections.unmodifiableSet(EnumSet.of(
-            SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS,
+            SZ_ENTITY_INCLUDE_RECORD_FEATURES,
             SZ_ENTITY_INCLUDE_ALL_FEATURES,
             SZ_ENTITY_INCLUDE_RECORD_DATA,
             SZ_ENTITY_INCLUDE_INTERNAL_FEATURES,
             SZ_INCLUDE_MATCH_KEY_DETAILS,
             SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO)));
         list.add(Collections.unmodifiableSet(EnumSet.of(
-            SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS,
+            SZ_ENTITY_INCLUDE_RECORD_FEATURES,
             SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES,
             SZ_ENTITY_INCLUDE_INTERNAL_FEATURES,
             SZ_INCLUDE_MATCH_KEY_DETAILS,