Package 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 Context Handler provides methods to build graph context for glossary terms.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryContextHandler(org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, AssetContextHandler assetContextHandler, HandlerHelper handlerHelper)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.common.collect.Multimap<String,org.odpi.openmetadata.accessservices.assetlineage.model.RelationshipsContext>
    buildGlossaryTermContext(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail glossaryTerm)
    Builds the context for a Glossary Term.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail
    getGlossaryTermDetails(String userId, String glossaryTermGUID)
    Returns the Glossary Term entity details based on the GlossaryTerm GUID
    boolean
    hasGlossaryTermLineageRelationships(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.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 Details

    • GlossaryContextHandler

      public GlossaryContextHandler(org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, AssetContextHandler assetContextHandler, HandlerHelper handlerHelper)
      Construct the handler information needed to interact with the repository services
      Parameters:
      invalidParameterHandler - handler for invalid parameters
      handlerHelper - the helper handler

  • Method Details

    • getGlossaryTermDetails

      public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail getGlossaryTermDetails(String userId, String glossaryTermGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns the Glossary Term entity details based on the GlossaryTerm GUID
      Parameters:
      userId - the unique identifier for the user
      glossaryTermGUID - the glossary term GUID
      Returns:
      the entity details for a glossary term based on the glossary term guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the entity.

    • buildGlossaryTermContext

      public com.google.common.collect.Multimap<String,org.odpi.openmetadata.accessservices.assetlineage.model.RelationshipsContext> buildGlossaryTermContext(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail glossaryTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
      Builds 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 - the unique identifier for the user
      glossaryTerm - the glossary term entity for which the context is built
      Returns:
      a map that contains the Glossary Term relationships and context
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase - checked exception for reporting errors found when using OCF connectors

    • hasGlossaryTermLineageRelationships

      public boolean hasGlossaryTermLineageRelationships(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entityDetail) throws org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
      Checks if the glossary term is involved in lineage relationships
      Parameters:
      userId - the unique identifier for the user
      entityDetail - the glossary term entity for which the context is built
      Returns:
      true if there are lineage relationships for the glossary term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase - checked exception for reporting errors found when using OCF connectors