Package org.odpi.openmetadata.commonservices.generichandlers

Class GlossaryHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.GlossaryHandler<B>

Type Parameters:

B - class that represents the glossary

public class GlossaryHandler<B>
extends ReferenceableHandler<B>

GlossaryHandler provides the exchange of metadata about glossaries between the repository and the OMAS. Note glossaries are governance metadata and are always defined with LOCAL-COHORT provenance.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor

Description

GlossaryHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)

Construct the handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method	Description
void	addCanonicalVocabClassificationToGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, String scope, String methodName)	Mark the glossary as a canonical vocabulary.
void	addTaxonomyClassificationToGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, String organizingPrinciple, String methodName)	Mark the glossary as a taxonomy.
String	createGlossary(String userId, String qualifiedName, String displayName, String description, String language, String usage, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)	Create the anchor object that all elements in a glossary (terms and categories) are linked to.
String	createGlossaryFromTemplate(String userId, String templateGUID, String qualifiedName, String displayName, String description, String methodName)	Create a new metadata element to represent a glossary using an existing metadata element as a template.
List<B>	findGlossaries(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, Date effectiveTime, String methodName)	Retrieve the list of glossary metadata elements that contain the search string.
List<B>	getGlossariesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, Date effectiveTime, String methodName)	Retrieve the list of glossary metadata elements with a matching qualified or display name.
B	getGlossaryByGUID(String userId, String guid, String guidParameterName, String methodName)	Retrieve the glossary metadata element with the supplied unique identifier.
void	removeCanonicalVocabClassificationFromGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, String methodName)	Remove the taxonomy designation from a glossary.
void	removeGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, String methodName)	Remove the metadata element representing a glossary.
void	removeTaxonomyClassificationFromGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, String methodName)	Remove the taxonomy designation from a glossary.
void	updateGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, String qualifiedName, String displayName, String description, String language, String usage, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)	Update the anchor object that all elements in a glossary (terms and categories) are linked to.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

addOwner, addSecurityTags, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCollectionMembers, getEntityByUniqueQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsPeerDuplicates, removeOwner, removeResourceListMember, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, entityMatchSearchCriteria, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEffectiveTime, getEffectiveTime, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getTypeDefByName, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, regexSearchCriteria, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryHandler

public GlossaryHandler(OpenMetadataAPIGenericConverter<B> converter,
                       Class<B> beanClass,
                       String serviceName,
                       String serverName,
                       InvalidParameterHandler invalidParameterHandler,
                       RepositoryHandler repositoryHandler,
                       OMRSRepositoryHelper repositoryHelper,
                       String localServerUserId,
                       OpenMetadataServerSecurityVerifier securityVerifier,
                       List<String> supportedZones,
                       List<String> defaultZones,
                       List<String> publishZones,
                       AuditLog auditLog)

Construct the handler with information needed to work with B objects.

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve B instances from

defaultZones - list of zones that the access service should set in all new B instances

publishZones - list of zones that the access service sets up in published B instances

auditLog - destination for audit log events

Method Detail

createGlossary

public String createGlossary(String userId,
                             String qualifiedName,
                             String displayName,
                             String description,
                             String language,
                             String usage,
                             Map<String,String> additionalProperties,
                             String suppliedTypeName,
                             Map<String,Object> extendedProperties,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create the anchor object that all elements in a glossary (terms and categories) are linked to.

Parameters:

userId - calling user

qualifiedName - unique name for the glossary - used in other configuration

displayName - short display name for the glossary

description - description of the governance glossary

language - the language used in the glossary definitions

usage - intended usage of the glossary

additionalProperties - additional properties for a glossary

suppliedTypeName - type name from the caller (enables creation of subtypes)

extendedProperties - properties for a governance glossary subtype

methodName - calling method

Returns:

unique identifier of the new glossary object

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createGlossaryFromTemplate

public String createGlossaryFromTemplate(String userId,
                                         String templateGUID,
                                         String qualifiedName,
                                         String displayName,
                                         String description,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Create a new metadata element to represent a glossary using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is used as a template, any linked terms and categories are created as well.

Parameters:

userId - calling user

templateGUID - unique identifier of the metadata element to copy

qualifiedName - unique name for the new element - used in other configuration

displayName - short display name for the new element

description - description of the new element

methodName - calling method

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGlossary

public void updateGlossary(String userId,
                           String glossaryGUID,
                           String glossaryGUIDParameterName,
                           String qualifiedName,
                           String displayName,
                           String description,
                           String language,
                           String usage,
                           Map<String,String> additionalProperties,
                           String suppliedTypeName,
                           Map<String,Object> extendedProperties,
                           String methodName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Update the anchor object that all elements in a glossary (terms and categories) are linked to.

Parameters:

userId - calling user

glossaryGUID - unique identifier of the glossary to update

glossaryGUIDParameterName - parameter passing the glossaryGUID

qualifiedName - unique name for the glossary - used in other configuration

displayName - short display name for the glossary

description - description of the governance glossary

language - the language used in the glossary definitions

usage - intended usage of the glossary

additionalProperties - additional properties for a governance glossary

suppliedTypeName - type of glossary

extendedProperties - properties for a governance glossary subtype

methodName - calling method

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addTaxonomyClassificationToGlossary

public void addTaxonomyClassificationToGlossary(String userId,
                                                String glossaryGUID,
                                                String glossaryGUIDParameterName,
                                                String organizingPrinciple,
                                                String methodName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Mark the glossary as a taxonomy.

Parameters:

userId - calling user

glossaryGUID - unique identifier of asset

glossaryGUIDParameterName - parameter name supplying glossaryGUID

organizingPrinciple - how the category hierarchy is organized

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeTaxonomyClassificationFromGlossary

public void removeTaxonomyClassificationFromGlossary(String userId,
                                                     String glossaryGUID,
                                                     String glossaryGUIDParameterName,
                                                     String methodName)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Remove the taxonomy designation from a glossary.

Parameters:

userId - calling user

glossaryGUID - unique identifier of asset

glossaryGUIDParameterName - parameter name supplying glossaryGUID

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addCanonicalVocabClassificationToGlossary

public void addCanonicalVocabClassificationToGlossary(String userId,
                                                      String glossaryGUID,
                                                      String glossaryGUIDParameterName,
                                                      String scope,
                                                      String methodName)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Mark the glossary as a canonical vocabulary.

Parameters:

userId - calling user

glossaryGUID - unique identifier of asset

glossaryGUIDParameterName - parameter name supplying glossaryGUID

scope - how the category hierarchy is organized

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeCanonicalVocabClassificationFromGlossary

public void removeCanonicalVocabClassificationFromGlossary(String userId,
                                                           String glossaryGUID,
                                                           String glossaryGUIDParameterName,
                                                           String methodName)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Remove the taxonomy designation from a glossary.

Parameters:

userId - calling user

glossaryGUID - unique identifier of asset

glossaryGUIDParameterName - parameter name supplying glossaryGUID

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeGlossary

public void removeGlossary(String userId,
                           String glossaryGUID,
                           String glossaryGUIDParameterName,
                           String methodName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms because the Anchors classifications are set up in these elements.

Parameters:

userId - calling user

glossaryGUID - unique identifier of the metadata element to remove

glossaryGUIDParameterName - parameter supplying the glossaryGUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGlossaries

public List<B> findGlossaries(String userId,
                              String searchString,
                              String searchStringParameterName,
                              int startFrom,
                              int pageSize,
                              Date effectiveTime,
                              String methodName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

searchStringParameterName - name of parameter supplying the search string

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - calling method

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossariesByName

public List<B> getGlossariesByName(String userId,
                                   String name,
                                   String nameParameterName,
                                   int startFrom,
                                   int pageSize,
                                   Date effectiveTime,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

nameParameterName - parameter supplying name

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - calling method

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryByGUID

public B getGlossaryByGUID(String userId,
                           String guid,
                           String guidParameterName,
                           String methodName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Retrieve the glossary metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

guidParameterName - parameter name of guid

methodName - calling method

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)