Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new flags pertaining to record-level features and made related … #43

Merged
merged 1 commit into from
Oct 3, 2024
Merged

Added new flags pertaining to record-level features and made related … #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 62 additions & 6 deletions src/main/java/com/senzing/sdk/SzFlag.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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.
Expand Down Expand Up @@ -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}
Expand All @@ -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.
Expand Down Expand Up @@ -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));
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down
15 changes: 8 additions & 7 deletions src/main/java/com/senzing/sdk/SzFlagUsageGroup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down
19 changes: 17 additions & 2 deletions src/main/java/com/senzing/sdk/SzFlags.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
12 changes: 11 additions & 1 deletion src/main/java/com/senzing/sdk/core/NativeEngine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/com/senzing/sdk/core/SzCoreDiagnosticTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/test/java/com/senzing/sdk/core/SzCoreEngineHowTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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,
Expand Down
Loading