DiscoveryAnalysisReportHandler (ODF Metadata Management Server-side Handlers 1.2 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.odf.metadatamanagement.handlers.DiscoveryAnalysisReportHandler

```
public class DiscoveryAnalysisReportHandler
extends Object
```
DiscoveryAnalysisReportHandler manages the storage and retrieval of metadata relating to discovery analysis reports as defined in the Open Discovery Framework (ODF).

Constructor Summary

Constructors
Constructor and Description
`DiscoveryAnalysisReportHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, AnnotationHandler annotationHandler)` Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addAnnotationToDiscoveryReport(String userId, String discoveryReportGUID, Annotation annotation, String methodName)` Add a new annotation to the annotation store as a top level annotation linked directly off of the report.
`DiscoveryAnalysisReport`	`createDiscoveryAnalysisReport(String userId, String qualifiedName, String displayName, String description, Date creationDate, Map<String,String> analysisParameters, DiscoveryRequestStatus discoveryRequestStatus, String assetGUID, String discoveryEngineGUID, String discoveryServiceGUID, Map<String,String> additionalProperties, List<Classification> classifications, String methodName)` Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
`List<Annotation>`	`getAnnotationsForAssetByStatus(String userId, String assetGUID, AnnotationStatus status, int startingFrom, int maximumResults, String methodName)` Return the list of annotations from previous runs of the discovery service that are set to a specific status.
`DiscoveryAnalysisReport`	`getDiscoveryAnalysisReport(String userId, String discoveryReportGUID, String methodName)` Request the discovery report for a discovery request that has completed.
`List<DiscoveryAnalysisReport>`	`getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults, String methodName)` Return the discovery analysis reports about the asset.
`List<Annotation>`	`getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults, String methodName)` Return the annotations linked direction to the report.
`DiscoveryAnalysisReport`	`updateDiscoveryAnalysisReport(String userId, String discoveryReportGUID, DiscoveryAnalysisReport updatedReport)` Update the properties of the discovery analysis report.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscoveryAnalysisReportHandler

public DiscoveryAnalysisReportHandler(String serviceName,
                                      String serverName,
                                      InvalidParameterHandler invalidParameterHandler,
                                      RepositoryHandler repositoryHandler,
                                      OMRSRepositoryHelper repositoryHelper,
                                      AnnotationHandler annotationHandler)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects; annotationHandler - handler for managing annotations

Method Detail

createDiscoveryAnalysisReport

public DiscoveryAnalysisReport createDiscoveryAnalysisReport(String userId,
                                                             String qualifiedName,
                                                             String displayName,
                                                             String description,
                                                             Date creationDate,
                                                             Map<String,String> analysisParameters,
                                                             DiscoveryRequestStatus discoveryRequestStatus,
                                                             String assetGUID,
                                                             String discoveryEngineGUID,
                                                             String discoveryServiceGUID,
                                                             Map<String,String> additionalProperties,
                                                             List<Classification> classifications,
                                                             String methodName)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.

Parameters:: userId - calling user; qualifiedName - unique name for the report; displayName - short name for the report; description - description of the report; creationDate - data of the report; analysisParameters - analysis parameters passed to the discovery service; discoveryRequestStatus - current status of the discovery processing; assetGUID - unique identifier of the asset being analysed; discoveryEngineGUID - unique identifier of the discovery engine that is running the discovery service; discoveryServiceGUID - unique identifier of the discovery service creating the report; additionalProperties - additional properties for the report; classifications - classifications to attach to the report; methodName - calling method
Returns:: The new discovery report.
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to access the asset and/or report; PropertyServerException - there was a problem in the store whether the asset/report properties are kept.

updateDiscoveryAnalysisReport

public DiscoveryAnalysisReport updateDiscoveryAnalysisReport(String userId,
                                                             String discoveryReportGUID,
                                                             DiscoveryAnalysisReport updatedReport)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Update the properties of the discovery analysis report.

Parameters:: userId - calling user.; updatedReport - updated report - this will replace what was previous stored.; discoveryReportGUID - identifier of the discovery report
Returns:: the new values stored in the repository
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryAnalysisReport

public DiscoveryAnalysisReport getDiscoveryAnalysisReport(String userId,
                                                          String discoveryReportGUID,
                                                          String methodName)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Request the discovery report for a discovery request that has completed.

Parameters:: userId - identifier of calling user; discoveryReportGUID - identifier of the discovery request.; methodName - calling method
Returns:: discovery report
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryAnalysisReports

public List<DiscoveryAnalysisReport> getDiscoveryAnalysisReports(String userId,
                                                                 String assetGUID,
                                                                 int startingFrom,
                                                                 int maximumResults,
                                                                 String methodName)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Return the discovery analysis reports about the asset.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset; startingFrom - position in the list (used when there are so many reports that paging is needed; maximumResults - maximum number of elements to return an this call; methodName - calling method
Returns:: list of discovery analysis reports
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryReportAnnotations

public List<Annotation> getDiscoveryReportAnnotations(String userId,
                                                      String discoveryReportGUID,
                                                      AnnotationStatus annotationStatus,
                                                      int startingFrom,
                                                      int maximumResults,
                                                      String methodName)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return the annotations linked direction to the report.

Parameters:: userId - identifier of calling user; discoveryReportGUID - identifier of the discovery request.; annotationStatus - status of the desired annotations - null means all statuses.; startingFrom - initial position in the stored list.; maximumResults - maximum number of definitions to return on this call.; methodName - calling method
Returns:: list of annotations
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - there was a problem that occurred within the property server.

getAnnotationsForAssetByStatus

public List<Annotation> getAnnotationsForAssetByStatus(String userId,
                                                       String assetGUID,
                                                       AnnotationStatus status,
                                                       int startingFrom,
                                                       int maximumResults,
                                                       String methodName)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Return the list of annotations from previous runs of the discovery service that are set to a specific status. If status is null then annotations that have been reviewed, approved and/or actioned are returned from discovery reports that are not waiting or in progress.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset; status - status value to use on the query; startingFrom - starting position in the list.; maximumResults - maximum number of elements that can be returned; methodName - calling method
Returns:: list of annotation (or null if none are registered)
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user id not authorized to issue this request; PropertyServerException - there was a problem retrieving annotations from the annotation store.

addAnnotationToDiscoveryReport

public String addAnnotationToDiscoveryReport(String userId,
                                             String discoveryReportGUID,
                                             Annotation annotation,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Add a new annotation to the annotation store as a top level annotation linked directly off of the report.

Parameters:: userId - identifier of calling user; discoveryReportGUID - unique identifier of the discovery analysis report; annotation - annotation object; methodName - calling method
Returns:: unique identifier of new annotation
Throws:: InvalidParameterException - the annotation is invalid; UserNotAuthorizedException - the user id not authorized to issue this request; PropertyServerException - there was a problem retrieving adding the annotation to the annotation store.

Class DiscoveryAnalysisReportHandler