Package org.odpi.openmetadata.accessservices.glossaryview.server.service

Class TermService

java.lang.Object
org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient
org.odpi.openmetadata.accessservices.glossaryview.server.service.GlossaryViewOMAS
org.odpi.openmetadata.accessservices.glossaryview.server.service.TermService
public class TermService extends GlossaryViewOMAS
Server-side implementation of the Glossary View Open Metadata Access Service (OMAS). Deals in extracting terms.

  • Constructor Details

    • TermService

      public TermService()

  • Method Details

    • getTerm

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTerm(String userId, String serverName, String termGUID)
      Extract the term definition for the given GUID
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      Returns:
      EntityDetailResponse term

    • getAllGlossaryTerms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAllGlossaryTerms(String userId, String serverName, Integer from, Integer size)
      Extract all terms definitions
      Parameters:
      userId - calling user
      serverName - instance to call
      from - offset start for the return values
      size - maximum number of results
      Returns:
      EntityDetailResponse all terms

    • getTermsViaTermAnchorRelationships

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTermsViaTermAnchorRelationships(String userId, String serverName, String glossaryGUID, Integer from, Integer size)
      Extract term definitions for the given glossary GUID via the 'TermAnchor' type relationships
      Parameters:
      userId - calling user
      serverName - instance to call
      glossaryGUID - glossary GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse all external glossaries

    • getTermsViaTermCategorizationRelationships

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTermsViaTermCategorizationRelationships(String userId, String serverName, String categoryGUID, Integer from, Integer size)
      Extract term definitions for the given GUID via the 'TermCategorization' type relationships
      Parameters:
      userId - calling user
      serverName - instance to call
      categoryGUID - category GUID
      from - from
      size - size
      Returns:
      terms

    • getExternalGlossaryLinks

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getExternalGlossaryLinks(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract external glossary definitions for the given term
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse all external glossaries

    • getRelatedTerms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getRelatedTerms(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract related terms
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse related terms

    • getSynonyms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getSynonyms(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract synonyms
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse synonyms

    • getAntonyms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAntonyms(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract antonyms
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse antonyms

    • getPreferredTerms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getPreferredTerms(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract preferred terms
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse preferred terms

    • getReplacementTerms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getReplacementTerms(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract replacement terms
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse replacement terms

    • getTranslations

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTranslations(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract translations
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse translations

    • getIsA

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getIsA(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract "is a"
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse "is a"

    • getValidValues

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getValidValues(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract valid values
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse valid values

    • getUsedInContexts

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getUsedInContexts(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract "used in contexts"
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse "used in contexts"

    • getAssignedElements

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAssignedElements(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract assigned elements
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse semantic assignments

    • getAttributes

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAttributes(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract attributes
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse semantic assignments

    • getSubtypes

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getSubtypes(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract subtypes
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse semantic assignments

    • getTypes

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTypes(String userId, String serverName, String termGUID, Integer from, Integer size)
      Extract types
      Parameters:
      userId - calling user
      serverName - instance to call
      termGUID - term GUID
      from - from
      size - size
      Returns:
      EntityDetailResponse semantic assignments

    • getAllTerms

      public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAllTerms(String userId, String serverName, Integer from, Integer size)
      Extract all terms definitions
      Parameters:
      userId - calling user
      serverName - instance to call
      from - offset start for the return values
      size - maximum number of results
      Returns:
      EntityDetailResponse all glossaries