Uses of Enum Class
com.senzing.sdk.SzFlag

Packages that use SzFlag

Package	Description
com.senzing.sdk	This package provides the interfaces, utility classes, enumerations, constants and exception types pertaining to the Senzing SDK for Java.
com.senzing.sdk.core	This package provides the "core" implementation of the Senzing SDK for Java defined in the com.senzing.sdk package.

Uses of SzFlag in com.senzing.sdk

Fields in com.senzing.sdk with type parameters of type SzFlag

Modifier and Type	Field	Description
static final Set<SzFlag>	SzFlag.SZ_ENTITY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_ENTITY usage group.
static final Set<SzFlag>	SzFlag.SZ_ENTITY_BRIEF_DEFAULT_FLAGS	The Set of SzFlag instances for the default flags for a "brief" level of detail when retrieving entities.
static final Set<SzFlag>	SzFlag.SZ_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances for the default level of detail when retrieving entities.
static final Set<SzFlag>	SzFlag.SZ_ENTITY_INCLUDE_ALL_RELATIONS	The unmodifiable Set of SzFlag instances indicating that that entities that are returned should include all relationships regardless of the kind of relationship.
static final Set<SzFlag>	SzFlag.SZ_EXPORT_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_EXPORT usage group.
static final Set<SzFlag>	SzFlag.SZ_EXPORT_DEFAULT_FLAGS	The Set of SzFlag instances for the default flags for exporting entities.
static final Set<SzFlag>	SzFlag.SZ_EXPORT_INCLUDE_ALL_ENTITIES	The unmodifiable Set of SzFlag instances indicating that an export should include all entities in the export.
static final Set<SzFlag>	SzFlag.SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS	The Set of SzFlag instances indicating that an export should include all entities having a relationships of any kind.
static final Set<SzFlag>	SzFlag.SZ_FIND_NETWORK_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_NETWORK usage group.
static final Set<SzFlag>	SzFlag.SZ_FIND_NETWORK_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "find network" operations.
static final Set<SzFlag>	SzFlag.SZ_FIND_PATH_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_FIND_PATH usage group.
static final Set<SzFlag>	SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "find path" operations.
static final Set<SzFlag>	SzFlag.SZ_HOW_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_HOW usage group.
static final Set<SzFlag>	SzFlag.SZ_HOW_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "how entity" operations that analyze how an entity was formed.
static final Set<SzFlag>	SzFlag.SZ_MODIFY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_MODIFY usage group.
static final Set<SzFlag>	SzFlag.SZ_NO_FLAGS	An unmodifiable Set of SzFlag instances containing NO flags (an empty set).
static final Set<SzFlag>	SzFlag.SZ_RECORD_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_RECORD usage group.
static final Set<SzFlag>	SzFlag.SZ_RECORD_DEFAULT_FLAGS	The Set of SzFlag instances for the default level of detail when retrieving records.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_SEARCH usage group.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_BY_ATTRIBUTES_ALL	The Set of SzFlag instances that are a good default when searching for all matching entities regardless of match level.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS	The Set of SzFlag instances that are a good default for searching by attributes and returning basic entity data.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL	The Set of SzFlag instances that are a good for searching by attributes when returning minimal data for the entities.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG	The Set of SzFlag instances that are a good for searching by attributes for strong search matches and returning minimal data for the entities.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_BY_ATTRIBUTES_STRONG	The Set of SzFlag instances that are a good default when searching foor strongly matching entities.
static final Set<SzFlag>	SzFlag.SZ_SEARCH_INCLUDE_ALL_ENTITIES	The Set of SzFlag instances indicating that search results should include entities that related to the search attributes at any match level.
static final Set<SzFlag>	SzFlag.SZ_VIRTUAL_ENTITY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_VIRTUAL_ENTITY usage group.
static final Set<SzFlag>	SzFlag.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "how entity" operations that analyze how an entity was formed.
static final Set<SzFlag>	SzFlag.SZ_WHY_ALL_FLAGS	The unmodifiable Set of SzFlag instances containing all SzFlag instances belonging to the SzFlagUsageGroup.SZ_WHY usage group.
static final Set<SzFlag>	SzFlag.SZ_WHY_ENTITIES_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "why entities" operations.
static final Set<SzFlag>	SzFlag.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "why record in entity" operations.
static final Set<SzFlag>	SzFlag.SZ_WHY_RECORDS_DEFAULT_FLAGS	The Set of SzFlag instances indicating that are good defaults for "why records" operations.
static final Set<SzFlag>	SzFlag.SZ_WITH_INFO_FLAGS	The unmodifiable Set of SzFlag instances containing the SzFlag instances to use when a repository-modifying operation is being invoked and the desired repsonse should contain an "INFO" message describing how the repository was affected as a result of the operation.

Methods in com.senzing.sdk that return SzFlag

Modifier and Type	Method	Description
static SzFlag	SzFlag.valueOf(String name)	Returns the enum constant of this class with the specified name.
static SzFlag[]	SzFlag.values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods in com.senzing.sdk that return types with arguments of type SzFlag

Modifier and Type	Method	Description
Set<SzFlag>	SzFlagUsageGroup.getFlags()	Gets the EnumSet of SzFlag instances that have this SzFlagUsageGroup.
static EnumSet<SzFlag>	SzFlag.intersect(Set<SzFlag> set1, Set<SzFlag> set2)	Creates a new EnumSet of SzFlag instances that represents the intersection between the two specified sets of SzFlag instances.
static EnumSet<SzFlag>	SzFlag.union(Set<SzFlag> set1, Set<SzFlag> set2)	Creates a new EnumSet of SzFlag instances that represents the union between the two specified sets of SzFlag instances.

Method parameters in com.senzing.sdk with type arguments of type SzFlag

Modifier and Type	Method	Description
String	SzEngine.addRecord(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags)	Loads the record described by the specified String record definition having the specified data source code and record ID using the specified Set of SzFlag values.
String	SzEngine.deleteRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Delete a previously loaded record identified by the data source code and record ID from the specified SzRecordKey.
long	SzEngine.exportCsvEntityReport(String csvColumnList, Set<SzFlag> flags)	Initiates an export of entity data in CSV format and returns an "export handle" that can be used to read the export data and must be closed when complete.
long	SzEngine.exportJsonEntityReport(Set<SzFlag> flags)	Iniitiates an export of entity data as JSON-lines format and returns an "export handle" that can be used to read the export data and must be closed when complete.
String	SzEngine.findNetwork(SzEntityIds entityIds, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Finds a network of entity relationships surrounding the paths between a set of entities identified by one or more entity ID's specified in an instance of SzEntityIds -- which is a Set of non-null Long entity ID's.
String	SzEngine.findNetwork(SzRecordKeys recordKeys, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Finds a network of entity relationships surrounding the paths between a set of entities having the constituent records identified by the data source code and record ID pairs contained in the specified instance of SzRecordKeys -- which is a Set of one or more non-null SzRecordKey instances.
String	SzEngine.getEntity(long entityId, Set<SzFlag> flags)	This method is used to retrieve information about a specific resolved entity.
String	SzEngine.getEntity(SzRecordKey recordKey, Set<SzFlag> flags)	This method is used to retrieve information about the resolved entity that contains a specific record that is identified by the data source code and record ID associated with the specified SzRecordKey.
String	SzEngine.getRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves the record identified by the data source code and record ID from the specified SzRecordKey.
String	SzEngine.howEntity(long entityId, Set<SzFlag> flags)	Deterimes how an entity identified by the specified entity ID was constructed from its constituent records.
static EnumSet<SzFlag>	SzFlag.intersect(Set<SzFlag> set1, Set<SzFlag> set2)	Creates a new EnumSet of SzFlag instances that represents the intersection between the two specified sets of SzFlag instances.
static boolean	SzFlag.intersects(Set<SzFlag> set1, Set<SzFlag> set2)	Checks if any intersection exists between two sets of SzFlag instances.
String	SzEngine.preprocessRecord(String recordDefinition, Set<SzFlag> flags)	Performs a hypothetical load of a the record described by the specified String record definition using the specified Set of SzFlag values.
String	SzEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)	Processes the specified redo record using the specified flags.
String	SzEngine.reevaluateEntity(long entityId, Set<SzFlag> flags)	Reevaluate a resolved entity identified by the specified entity ID.
String	SzEngine.reevaluateRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Reevaluate the record identified by the data source code and record ID from the specified SzRecordKey.
String	SzEngine.searchByAttributes(String attributes, String searchProfile, Set<SzFlag> flags)	This method searches for entities that match or relate to the provided search attributes using the optionally specified search profile.
String	SzEngine.searchByAttributes(String attributes, Set<SzFlag> flags)	This method is equivalent to calling SzEngine.searchByAttributes(String, String, Set) with a null value for the search profile parameter.
static long	SzFlag.toLong(Set<SzFlag> set)	Converts the specified EnumSet to its 64-bit long integer equivalent representing the bitwise flags.
static String	SzFlag.toString(Set<SzFlag> flagSet)	Returns the String representation describing the SzFlag instances in the specified Set.
static EnumSet<SzFlag>	SzFlag.union(Set<SzFlag> set1, Set<SzFlag> set2)	Creates a new EnumSet of SzFlag instances that represents the union between the two specified sets of SzFlag instances.
String	SzEngine.whyEntities(long entityId1, long entityId2, Set<SzFlag> flags)	Determines the ways in which two entities identified by the specified entity ID's are related to each other.
String	SzEngine.whyRecordInEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Determines why the record identified by the data source code and record ID in the specified in an SzRecordKey is included in its respective entity.
String	SzEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2, Set<SzFlag> flags)	Determines ways in which two records identified by the data source code and record ID pairs from the specified SzRecordKey instances are related to each other.

Uses of SzFlag in com.senzing.sdk.core

Method parameters in com.senzing.sdk.core with type arguments of type SzFlag

Modifier and Type	Method	Description
String	SzCoreEngine.addRecord(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags)	Loads the record described by the specified String record definition having the specified data source code and record ID using the specified Set of SzFlag values.
String	SzCoreEngine.deleteRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Delete a previously loaded record identified by the data source code and record ID from the specified SzRecordKey.
long	SzCoreEngine.exportCsvEntityReport(String csvColumnList, Set<SzFlag> flags)	Initiates an export of entity data in CSV format and returns an "export handle" that can be used to read the export data and must be closed when complete.
long	SzCoreEngine.exportJsonEntityReport(Set<SzFlag> flags)	Iniitiates an export of entity data as JSON-lines format and returns an "export handle" that can be used to read the export data and must be closed when complete.
String	SzCoreEngine.findNetwork(SzEntityIds entityIds, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Finds a network of entity relationships surrounding the paths between a set of entities identified by one or more entity ID's specified in an instance of SzEntityIds -- which is a Set of non-null Long entity ID's.
String	SzCoreEngine.findNetwork(SzRecordKeys recordKeys, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Finds a network of entity relationships surrounding the paths between a set of entities having the constituent records identified by the data source code and record ID pairs contained in the specified instance of SzRecordKeys -- which is a Set of one or more non-null SzRecordKey instances.
String	SzCoreEngine.getEntity(long entityId, Set<SzFlag> flags)	This method is used to retrieve information about a specific resolved entity.
String	SzCoreEngine.getEntity(SzRecordKey recordKey, Set<SzFlag> flags)	This method is used to retrieve information about the resolved entity that contains a specific record that is identified by the data source code and record ID associated with the specified SzRecordKey.
String	SzCoreEngine.getRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves the record identified by the data source code and record ID from the specified SzRecordKey.
String	SzCoreEngine.howEntity(long entityId, Set<SzFlag> flags)	Deterimes how an entity identified by the specified entity ID was constructed from its constituent records.
String	SzCoreEngine.preprocessRecord(String recordDefinition, Set<SzFlag> flags)	Performs a hypothetical load of a the record described by the specified String record definition using the specified Set of SzFlag values.
String	SzCoreEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)	Processes the specified redo record using the specified flags.
String	SzCoreEngine.reevaluateEntity(long entityId, Set<SzFlag> flags)	Reevaluate a resolved entity identified by the specified entity ID.
String	SzCoreEngine.reevaluateRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Reevaluate the record identified by the data source code and record ID from the specified SzRecordKey.
String	SzCoreEngine.searchByAttributes(String attributes, String searchProfile, Set<SzFlag> flags)	This method searches for entities that match or relate to the provided search attributes using the optionally specified search profile.
String	SzCoreEngine.searchByAttributes(String attributes, Set<SzFlag> flags)	This method is equivalent to calling SzEngine.searchByAttributes(String, String, Set) with a null value for the search profile parameter.
String	SzCoreEngine.whyEntities(long entityId1, long entityId2, Set<SzFlag> flags)	Determines the ways in which two entities identified by the specified entity ID's are related to each other.
String	SzCoreEngine.whyRecordInEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Determines why the record identified by the data source code and record ID in the specified in an SzRecordKey is included in its respective entity.
String	SzCoreEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2, Set<SzFlag> flags)	Determines ways in which two records identified by the data source code and record ID pairs from the specified SzRecordKey instances are related to each other.