Uses of Record Class
com.senzing.sdk.SzRecordKey
Package
Description
This package provides the interfaces, utility classes, enumerations,
constants and exception types pertaining to the Senzing SDK for Java.
This package provides the "core" implementation of the Senzing SDK for
Java defined in the
com.senzing.sdk
package.-
Uses of SzRecordKey in com.senzing.sdk
Modifier and TypeMethodDescriptionstatic SzRecordKey
Shorthand static for constructing a new instance ofSzRecordKey
with the specified data source code and record ID.Modifier and TypeMethodDescriptionSzEngine.addRecord
(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags) int
SzRecordKey.compareTo
(SzRecordKey recordKey) Implemented to sortSzRecordKey
instances first on data source code and then on record ID.SzEngine.deleteRecord
(SzRecordKey recordKey, Set<SzFlag> flags) Delete a previously loaded record identified by the data source code and record ID from the specifiedSzRecordKey
.SzEngine.findPath
(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, SzRecordKeys avoidRecordKeys, Set<String> requiredDataSources, Set<SzFlag> flags) Finds a relationship path between two entities identified by the data source codes and record ID's of their constituent records given by the specified start and endSzRecordKey
instances.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 specifiedSzRecordKey
.SzEngine.getRecord
(SzRecordKey recordKey, Set<SzFlag> flags) Retrieves the record identified by the data source code and record ID from the specifiedSzRecordKey
.SzRecordKeys.Builder.key
(SzRecordKey key) Adds anSzRecordKey
instance to thisSzRecordKeys.Builder
.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key) Constructs an instance with exactly oneSzRecordKey
.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey... keys) Constructs an instance with a variable-argument array ofSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2) Constructs an instance with exactly twoSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3) Constructs an instance with exactly threeSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4) Constructs an instance with exactly fourSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5) Constructs an instance with exactly fiveSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6) Constructs an instance with exactly sixSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7) Constructs an instance with exactly sevenSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7, SzRecordKey key8) Constructs an instance with exactly eightSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7, SzRecordKey key8, SzRecordKey key9) Constructs an instance with exactly nineSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7, SzRecordKey key8, SzRecordKey key9, SzRecordKey key10) Constructs an instance with exactly tenSzRecordKey
instances.SzEngine.reevaluateRecord
(SzRecordKey recordKey, Set<SzFlag> flags) Reevaluate the record identified by the data source code and record ID from the specifiedSzRecordKey
.SzEngine.whyRecordInEntity
(SzRecordKey recordKey, Set<SzFlag> flags) Determines why the record identified by the data source code and record ID in the specified in anSzRecordKey
is included in its respective entity.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 specifiedSzRecordKey
instances are related to each other.Modifier and TypeMethodDescriptionSzEngine.getVirtualEntity
(Set<SzRecordKey> recordKeys, Set<SzFlag> flags) Describes a hypothetically entity that would be composed of the one or more records identified by the data source code and record ID pairs in the specifiedSet
ofSzRecordKey
instances.static SzRecordKeys
SzRecordKeys.of
(Collection<SzRecordKey> keys) Constructs with the specifiedCollection
of non-nullSzRecordKey
instanes.ModifierConstructorDescriptionSzRecordKeys
(SzRecordKey key) Constructs an instance with exactly oneSzRecordKey
.SzRecordKeys
(SzRecordKey... keys) Constructs an instance with a variable-argument array ofSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2) Constructs an instance with exactly twoSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3) Constructs an instance with exactly threeSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4) Constructs an instance with exactly fourSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5) Constructs an instance with exactly fiveSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6) Constructs an instance with exactly sixSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7) Constructs an instance with exactly sevenSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7, SzRecordKey key8) Constructs an instance with exactly eightSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7, SzRecordKey key8, SzRecordKey key9) Constructs an instance with exactly nineSzRecordKey
instances.SzRecordKeys
(SzRecordKey key1, SzRecordKey key2, SzRecordKey key3, SzRecordKey key4, SzRecordKey key5, SzRecordKey key6, SzRecordKey key7, SzRecordKey key8, SzRecordKey key9, SzRecordKey key10) Constructs an instance with exactly tenSzRecordKey
instances.ModifierConstructorDescriptionSzRecordKeys
(Collection<SzRecordKey> keys) Constructs with the specifiedCollection
of non-nullSzRecordKey
instanes. -
Uses of SzRecordKey in com.senzing.sdk.core
Modifier and TypeMethodDescriptionSzCoreEngine.addRecord
(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags) SzCoreEngine.deleteRecord
(SzRecordKey recordKey, Set<SzFlag> flags) Delete a previously loaded record identified by the data source code and record ID from the specifiedSzRecordKey
.SzCoreEngine.findPath
(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, SzRecordKeys avoidRecordKeys, Set<String> requiredDataSources, Set<SzFlag> flags) Finds a relationship path between two entities identified by the data source codes and record ID's of their constituent records given by the specified start and endSzRecordKey
instances.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 specifiedSzRecordKey
.SzCoreEngine.getRecord
(SzRecordKey recordKey, Set<SzFlag> flags) Retrieves the record identified by the data source code and record ID from the specifiedSzRecordKey
.SzCoreEngine.reevaluateRecord
(SzRecordKey recordKey, Set<SzFlag> flags) Reevaluate the record identified by the data source code and record ID from the specifiedSzRecordKey
.SzCoreEngine.whyRecordInEntity
(SzRecordKey recordKey, Set<SzFlag> flags) Determines why the record identified by the data source code and record ID in the specified in anSzRecordKey
is included in its respective entity.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 specifiedSzRecordKey
instances are related to each other.Modifier and TypeMethodDescriptionprotected static String
SzCoreEngine.encodeRecordKeys
(Set<SzRecordKey> recordKeys) Encodes theSet
ofSzRecordKey
instances as JSON.SzCoreEngine.getVirtualEntity
(Set<SzRecordKey> recordKeys, Set<SzFlag> flags) Describes a hypothetically entity that would be composed of the one or more records identified by the data source code and record ID pairs in the specifiedSet
ofSzRecordKey
instances.