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.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient

instanceHandler

Constructor Summary

Constructors

Constructor	Description
TermService()

Method Summary

Modifier and Type	Method	Description
GlossaryViewEntityDetailResponse	getAllGlossaryTerms(String userId, String serverName, Integer from, Integer size)	Extract all terms definitions
GlossaryViewEntityDetailResponse	getAllTerms(String userId, String serverName, Integer from, Integer size)	Extract all terms definitions
GlossaryViewEntityDetailResponse	getAntonyms(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract antonyms
GlossaryViewEntityDetailResponse	getAssignedElements(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract assigned elements
GlossaryViewEntityDetailResponse	getAttributes(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract attributes
GlossaryViewEntityDetailResponse	getExternalGlossaryLinks(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract external glossary definitions for the given term
GlossaryViewEntityDetailResponse	getIsA(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract "is a"
GlossaryViewEntityDetailResponse	getPreferredTerms(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract preferred terms
GlossaryViewEntityDetailResponse	getRelatedTerms(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract related terms
GlossaryViewEntityDetailResponse	getReplacementTerms(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract replacement terms
GlossaryViewEntityDetailResponse	getSubtypes(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract subtypes
GlossaryViewEntityDetailResponse	getSynonyms(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract synonyms
GlossaryViewEntityDetailResponse	getTerm(String userId, String serverName, String termGUID)	Extract the term definition for the given GUID
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
GlossaryViewEntityDetailResponse	getTermsViaTermCategorizationRelationships(String userId, String serverName, String categoryGUID, Integer from, Integer size)	Extract term definitions for the given GUID via the 'TermCategorization' type relationships
GlossaryViewEntityDetailResponse	getTranslations(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract translations
GlossaryViewEntityDetailResponse	getTypes(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract types
GlossaryViewEntityDetailResponse	getUsedInContexts(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract "used in contexts"
GlossaryViewEntityDetailResponse	getValidValues(String userId, String serverName, String termGUID, Integer from, Integer size)	Extract valid values

Methods inherited from class org.odpi.openmetadata.accessservices.glossaryview.server.service.GlossaryViewOMAS

getAllEntityDetailsResponse, getEntityDetailResponse, getRelatedEntitiesResponse, getSubEntitiesResponse

Methods inherited from class org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient

getAllEntityDetails, getEntityDetail, getRelatedEntities, getSubEntities

Methods inherited from class java.lang.Object

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

Constructor Details

TermService

public TermService()

Method Details

getTerm

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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