org.odpi.openmetadata.commonservices.odf.metadatamanagement.handlers

Class AnnotationHandler

java.lang.Object

org.odpi.openmetadata.commonservices.odf.metadatamanagement.handlers.AnnotationHandler

public class AnnotationHandler
extends Object

AnnotationHandler manages the storage and retrieval of metadata relating to annotations as defined in the Open Discovery Framework (ODF).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	addAnnotationToAnnotation(String userId, String anchorAnnotationGUID, Annotation annotation, String methodName) Add a new annotation and link it to an existing annotation.
void	deleteAnnotation(String userId, String annotationGUID, String methodName) Remove an annotation from the annotation store.
Annotation	getAnnotation(String userId, String annotationGUID, String methodName) Retrieve a single annotation by unique identifier.
List<Annotation>	getExtendedAnnotations(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults, String methodName) Return any annotations attached to this annotation.
List<String>	getTypesOfAnnotation() Return the annotation subtype names.
Map<String,String>	getTypesOfAnnotationDescriptions() Return the list of annotation subtype names mapped to their descriptions.
void	updateAnnotation(String userId, String annotationGUID, Annotation annotation, String methodName) Replace the current properties of an annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationHandler

public AnnotationHandler(String serviceName,
                         String serverName,
                         InvalidParameterHandler invalidParameterHandler,
                         RepositoryHandler repositoryHandler,
                         OMRSRepositoryHelper repositoryHelper,
                         DataFieldHandler dataFieldHandler)

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

dataFieldHandler - handler for managing data fields

Method Detail

getTypesOfAnnotation

public List<String> getTypesOfAnnotation()

Return the annotation subtype names.

Returns:

list of type names that are subtypes of annotation

getTypesOfAnnotationDescriptions

public Map<String,String> getTypesOfAnnotationDescriptions()

Return the list of annotation subtype names mapped to their descriptions.

Returns:

list of type names that are subtypes of asset

getExtendedAnnotations

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

Return any annotations attached to this annotation.

Parameters:

userId - identifier of calling user

annotationGUID - anchor annotation

annotationStatus - status of the desired annotations - null means all statuses.

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

methodName - calling method

Returns:

list of Annotation objects

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.

getAnnotation

public Annotation getAnnotation(String userId,
                                String annotationGUID,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Retrieve a single annotation by unique identifier. This call is typically used to retrieve the latest values for an annotation.

Parameters:

userId - identifier of calling user

annotationGUID - unique identifier of the annotation

methodName - calling method

Returns:

Annotation object

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.

addAnnotationToAnnotation

public String addAnnotationToAnnotation(String userId,
                                        String anchorAnnotationGUID,
                                        Annotation annotation,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Add a new annotation and link it to an existing annotation.

Parameters:

userId - identifier of calling user

anchorAnnotationGUID - unique identifier of the annotation that this new one os to be attached to

annotation - annotation object

methodName - calling method

Returns:

fully filled out annotation

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user id not authorized to issue this request

PropertyServerException - there was a problem saving annotations in the annotation store.

updateAnnotation

public void updateAnnotation(String userId,
                             String annotationGUID,
                             Annotation annotation,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Replace the current properties of an annotation.

Parameters:

userId - identifier of calling user

annotationGUID - unique identifier

annotation - new properties

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user id not authorized to issue this request

PropertyServerException - there was a problem updating the annotation in the annotation store.

deleteAnnotation

public void deleteAnnotation(String userId,
                             String annotationGUID,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove an annotation from the annotation store.

Parameters:

userId - identifier of calling user

annotationGUID - unique identifier of the annotation

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user id not authorized to issue this request

PropertyServerException - there was a problem deleting the annotation from the annotation store.