org.odpi.openmetadata.accessservices.assetlineage.handlers

Class GlossaryContextHandler

java.lang.Object

org.odpi.openmetadata.accessservices.assetlineage.handlers.GlossaryContextHandler

public class GlossaryContextHandler
extends Object

The glossary handler provide methods to provide business glossary terms for lineage.

Constructor Summary

Constructors

Constructor and Description
GlossaryContextHandler(InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, RepositoryHandler repositoryHandler, AssetContextHandler assetContextHandler, Set<String> lineageClassificationTypes) Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
Map<String,Set<GraphContext>>	buildGlossaryTermContext(String userId, EntityDetail glossaryTerm) Returns the context for a Glossary Term.
EntityDetail	getGlossaryTermDetails(String userId, String glossaryTermGUID) Returns the Glossary Term entity details based on the GlossaryTerm GUID
boolean	hasGlossaryTermLineageRelationships(String userId, EntityDetail entityDetail) Checks if the glossary term is involved in lineage relationships

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryContextHandler

public GlossaryContextHandler(InvalidParameterHandler invalidParameterHandler,
                              OMRSRepositoryHelper repositoryHelper,
                              RepositoryHandler repositoryHandler,
                              AssetContextHandler assetContextHandler,
                              Set<String> lineageClassificationTypes)

Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

Method Detail

getGlossaryTermDetails

public EntityDetail getGlossaryTermDetails(String userId,
                                           String glossaryTermGUID)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Returns the Glossary Term entity details based on the GlossaryTerm GUID

Parameters:

userId - String - userId of user making request.

glossaryTermGUID - the glossary term GUID

Returns:

the entity details for a glossary term based on the glossary term guid

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the entity.

buildGlossaryTermContext

public Map<String,Set<GraphContext>> buildGlossaryTermContext(String userId,
                                                              EntityDetail glossaryTerm)
                                                       throws OCFCheckedExceptionBase

Returns the context for a Glossary Term. This context contains the full description for the Schema Elements that have a Semantic Assigment to the GlossaryTerm

Parameters:

userId - String - userId of user making request.

glossaryTerm - the glossary term entity for which the context is built

Returns:

a map that contains the Glossary Term relationships and context

Throws:

OCFCheckedExceptionBase - checked exception for reporting errors found when using OCF connectors

hasGlossaryTermLineageRelationships

public boolean hasGlossaryTermLineageRelationships(String userId,
                                                   EntityDetail entityDetail)
                                            throws UserNotAuthorizedException,
                                                   PropertyServerException

Checks if the glossary term is involved in lineage relationships

Parameters:

userId - the user Id of user making request.

entityDetail - the glossary term entity for which the context is built

Returns:

true if there are lineage relationships for the glossary term

Throws:

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - the property server exception