Uses of Class
com.senzing.sdk.SzException

Packages that use SzException
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 SzException in com.senzing.sdk

    Subclasses of SzException in com.senzing.sdk
    Modifier and Type
    Class
    Description
    class 
    SzBadInputException
    Defines an exceptional condition when an invalid input value is provided to a Senzing operation preventing the successful completion of that operation.
    class 
    SzNotFoundException
    Extends SzBadInputException to define an exceptional condition where the provided bad input to a Senzing operation is an identifier that could not be used to successfully locate required data for that operation.
    class 
    SzReplaceConflictException
    Describes an exceptional condition when an attempt is made to replace a Senzing value with a new value providing it has not not already been changed, however, the current value is no longer the expected value and has therefore already been changed.
    class 
    SzUnknownDataSourceException
    Extends SzBadInputException to define an exceptional condition where a specified data source code is not confifgured in the current active configuration and therefore the data source could not be found.
    Methods in com.senzing.sdk that throw SzException
    Modifier and Type
    Method
    Description
    long
    SzConfigManager.addConfig(String configDefinition, String configComment)
    Adds the configuration described by the specified JSON to the repository with the specified comment and returns the identifier for referencing the the config in the entity repository.
    String
    SzConfig.addDataSource(long configHandle, String dataSourceCode)
    Adds a new data source that is identified by the specified data source code to the in-memory configuration associated with the specified configuraiton handle.
    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
    SzDiagnostic.checkDatastorePerformance(int secondsToRun)
    Runs non-destruction DB performance tests and returns detail of the result as a JSON String.
    void
    SzConfig.closeConfig(long configHandle)
    Closes the in-memory configuration associated with the specified config handle and cleans up system resources.
    void
    SzEngine.closeExport(long exportHandle)
    This function closes an export handle of a previously opened export to clean up system resources.
    long
    SzEngine.countRedoRecords()
    Gets the number of redo records pending to be processed.
    long
    SzConfig.createConfig()
    Creates a new in-memory configuration using the default configuraiton template and returns the configuration handle for working with it.
    void
    SzConfig.deleteDataSource(long configHandle, String dataSourceCode)
    Deletes the data source identified by the specified data source code from the in-memory configuration associated with the specified config handle.
    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.
    String
    SzConfig.exportConfig(long configHandle)
    Obtains the configuration definition formatted as JSON for the in-memory configuration associated with the specified configuration handle.
    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.fetchNext(long exportHandle)
    Fetches the next line of entity data from the export identified by the specified export handle.
    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.findPath(long startEntityId, long endEntityId, int maxDegrees, SzEntityIds avoidEntityIds, Set<String> requiredDataSources, Set<SzFlag> flags)
    Finds a relationship path between two entities identified by their entity ID's.
    String
    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 end SzRecordKey instances.
    long
    SzEnvironment.getActiveConfigId()
    Gets the currently active configuration ID for the SzEnvironment.
    String
    SzConfigManager.getConfig(long configId)
    Gets the configuration with the specified config ID and returns the configuration defintion as a String.
    SzConfig
    SzEnvironment.getConfig()
    Provides a reference to the SzConfig instance associated with this SzEnvironment.
    SzConfigManager
    SzEnvironment.getConfigManager()
    Provides a reference to the SzConfigManager instance associated with this SzEnvironment.
    String
    SzConfigManager.getConfigs()
    Gets the list of saved configuration ID's with their comments and timestamps and return the JSON String describing them.
    String
    SzConfig.getDataSources(long configHandle)
    Extracts the data sources from the in-memory configuration associated with the specified config handle returns the JSON text describing the data sources from the configuration.
    String
    SzDiagnostic.getDatastoreInfo()
    Gathers detailed information on the data store and returns it as a JSON String.
    long
    SzConfigManager.getDefaultConfigId()
    Gets the configuration ID of the default configuration for the repository and returns it.
    SzDiagnostic
    SzEnvironment.getDiagnostic()
    Provides a reference to the SzDiagnostic instance associated with this SzEnvironment.
    SzEngine
    SzEnvironment.getEngine()
    Provides a reference to the SzEngine instance associated with this SzEnvironment.
    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
    SzDiagnostic.getFeature(long featureId)
    Experimental/internal method for obtaining diagnostic feature definition for the specified feature identifier.
    String
    SzProduct.getLicense()
    Returns the currently configured license details.
    SzProduct
    SzEnvironment.getProduct()
    Provides a reference to the SzProduct instance associated with this SzEnvironment.
    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.getRedoRecord()
    Retrieves a pending redo record from the reevaluation queue.
    String
    SzEngine.getStats()
    Returns the current internal engine workload statistics for the process.
    String
    SzProduct.getVersion()
    Returns the currently installed version details.
    String
    SzEngine.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 specified Set of SzRecordKey instances.
    String
    SzEngine.howEntity(long entityId, Set<SzFlag> flags)
    Deterimes how an entity identified by the specified entity ID was constructed from its constituent records.
    long
    SzConfig.importConfig(String configDefinition)
    Creates a new in-memory configuration using the specified configuration definition and returns the configuration handle for working with it.
    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.
    void
    SzEngine.primeEngine()
    May optionally be called to pre-initialize some of the heavier weight internal resources of the SzEngine.
    String
    SzEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)
    Processes the specified redo record using the specified flags.
    void
    SzDiagnostic.purgeRepository()
    Purges all data in the configured repository.
    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.
    void
    SzEnvironment.reinitialize(long configId)
    Reinitializes the SzEnvironment with the specified configuration ID.
    void
    SzConfigManager.replaceDefaultConfigId(long currentDefaultConfigId, long newDefaultConfigId)
    Replaces the current configuration ID of the repository with the specified new configuration ID providing the current configuration ID of the repository is equal to the specified old configuration ID.
    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.
    void
    SzConfigManager.setDefaultConfigId(long configId)
    Sets the default configuration for the repository to the specified configuration ID.
    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 SzException in com.senzing.sdk.core

    Methods in com.senzing.sdk.core that throw SzException
    Modifier and Type
    Method
    Description
    long
    SzCoreConfigManager.addConfig(String configDefinition, String configComment)
    Adds the configuration described by the specified JSON to the repository with the specified comment and returns the identifier for referencing the the config in the entity repository.
    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
    SzCoreDiagnostic.checkDatastorePerformance(int secondsToRun)
    Runs non-destruction DB performance tests and returns detail of the result as a JSON String.
    void
    SzCoreEngine.closeExport(long exportHandle)
    This function closes an export handle of a previously opened export to clean up system resources.
    long
    SzCoreEngine.countRedoRecords()
    Gets the number of redo records pending to be processed.
    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.fetchNext(long exportHandle)
    Fetches the next line of entity data from the export identified by the specified export handle.
    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.findPath(long startEntityId, long endEntityId, int maxDegrees, SzEntityIds avoidEntityIds, Set<String> requiredDataSources, Set<SzFlag> flags)
    Finds a relationship path between two entities identified by their entity ID's.
    String
    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 end SzRecordKey instances.
    long
    SzCoreEnvironment.getActiveConfigId()
     
    String
    SzCoreConfigManager.getConfig(long configId)
    Gets the configuration with the specified config ID and returns the configuration defintion as a String.
    SzConfig
    SzCoreEnvironment.getConfig()
     
    SzConfigManager
    SzCoreEnvironment.getConfigManager()
     
    String
    SzCoreConfigManager.getConfigs()
    Gets the list of saved configuration ID's with their comments and timestamps and return the JSON String describing them.
    String
    SzCoreDiagnostic.getDatastoreInfo()
    Gathers detailed information on the data store and returns it as a JSON String.
    long
    SzCoreConfigManager.getDefaultConfigId()
    Gets the configuration ID of the default configuration for the repository and returns it.
    SzDiagnostic
    SzCoreEnvironment.getDiagnostic()
     
    SzEngine
    SzCoreEnvironment.getEngine()
     
    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
    SzCoreDiagnostic.getFeature(long featureId)
    Experimental/internal method for obtaining diagnostic feature definition for the specified feature identifier.
    String
    SzCoreProduct.getLicense()
    Returns the currently configured license details.
    SzProduct
    SzCoreEnvironment.getProduct()
     
    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.getRedoRecord()
    Retrieves a pending redo record from the reevaluation queue.
    String
    SzCoreEngine.getStats()
    Returns the current internal engine workload statistics for the process.
    String
    SzCoreProduct.getVersion()
    Returns the currently installed version details.
    String
    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 specified Set of SzRecordKey instances.
    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.
    void
    SzCoreEngine.primeEngine()
    May optionally be called to pre-initialize some of the heavier weight internal resources of the SzEngine.
    String
    SzCoreEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)
    Processes the specified redo record using the specified flags.
    void
    SzCoreDiagnostic.purgeRepository()
    Purges all data in the configured repository.
    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.
    void
    SzCoreEnvironment.reinitialize(long configId)
     
    void
    SzCoreConfigManager.replaceDefaultConfigId(long currentDefaultConfigId, long newDefaultConfigId)
    Replaces the current configuration ID of the repository with the specified new configuration ID providing the current configuration ID of the repository is equal to the specified old configuration ID.
    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.
    void
    SzCoreConfigManager.setDefaultConfigId(long configId)
    Sets the default configuration for the repository to the specified configuration ID.
    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.