org.odpi.openmetadata.commonservices.odf.metadatamanagement.builders

Class AnnotationBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.odf.metadatamanagement.builders.AnnotationBuilder

Direct Known Subclasses:

SuspectDuplicateAnnotationBuilder

public class AnnotationBuilder
extends Object

AnnotationBuilder supports the creation of the entities and relationships that describe an Open Discovery Framework (ODF) Annotation.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	additionalProperties
protected String	analysisStep
protected String	annotationType
protected int	confidenceLevel
protected String	explanation
protected String	expression
protected String	jsonProperties
protected OMRSRepositoryHelper	repositoryHelper
protected String	serverName
protected String	serviceName
protected String	summary

Constructor Summary

Constructors

Constructor and Description
AnnotationBuilder(String annotationType, String summary, int confidenceLevel, String expression, String explanation, String analysisStep, String jsonProperties, Map<String,String> additionalProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Create a builder to convert the properties of the annotation bean into repository services instances.

Method Summary

Modifier and Type	Method and Description
InstanceProperties	getAnnotationInstanceProperties(String methodName) Return the supplied bean properties in an InstanceProperties object for the annotation entity.

Methods inherited from class java.lang.Object

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

Field Detail

annotationType

protected String annotationType

summary

protected String summary

confidenceLevel

protected int confidenceLevel

expression

protected String expression

explanation

protected String explanation

analysisStep

protected String analysisStep

jsonProperties

protected String jsonProperties

additionalProperties

protected Map<String,String> additionalProperties

repositoryHelper

protected OMRSRepositoryHelper repositoryHelper

serviceName

protected String serviceName

serverName

protected String serverName

Constructor Detail

AnnotationBuilder

public AnnotationBuilder(String annotationType,
                         String summary,
                         int confidenceLevel,
                         String expression,
                         String explanation,
                         String analysisStep,
                         String jsonProperties,
                         Map<String,String> additionalProperties,
                         OMRSRepositoryHelper repositoryHelper,
                         String serviceName,
                         String serverName)

Create a builder to convert the properties of the annotation bean into repository services instances.

Parameters:

annotationType - type of annotation

summary - summary of the annotation

confidenceLevel - how confident was discovery service that the results are correct

expression - expression that summarizes the results

explanation - explanation of the results

analysisStep - analysis step in the discovery service that produced this annotation

jsonProperties - JSON properties passed to discovery service

additionalProperties - additional properties

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

getAnnotationInstanceProperties

public InstanceProperties getAnnotationInstanceProperties(String methodName)
                                                   throws InvalidParameterException

Return the supplied bean properties in an InstanceProperties object for the annotation entity.

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties