Skip to content

Commit

Permalink
Merge pull request #7619 from mandy-chessell/code2023
Browse files Browse the repository at this point in the history 
Add support for editing glossary
  • Loading branch information
@mandy-chessell
mandy-chessell authored Apr 16, 2023
2 parents 18c126d + b50e935 commit ea12067
Show file tree
Hide file tree
Showing 37 changed files with 4,058 additions and 283 deletions.
6 changes: 5 additions & 1 deletion build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,11 @@ subprojects {

// javadoc
javadoc {
options.addBooleanOption('html5', true)
options
{
addBooleanOption('html5', true)
setMemberLevel JavadocMemberLevel.PUBLIC
}
}

publishing {
Expand Down
2 changes: 1 addition & 1 deletion content-packs/OpenMetadataTypes.json
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions gradle.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ org.gradle.daemon.idletimeout=3600000
mavenRepoName=OSSRH

# Maven publish repository url
# it can be overriden by env variable ORG_GRADLE_PROJECT_mavenRepoUrl
# it can be overridden by env variable ORG_GRADLE_PROJECT_mavenRepoUrl
mavenRepoUrl=https://oss.sonatype.org/content/repositories/snapshots

# Maven publish repository user
# it can be overriden by env variable ORG_GRADLE_PROJECT_mavenRepoUser
# it can be overridden by env variable ORG_GRADLE_PROJECT_mavenRepoUser
mavenRepoUser=
# Maven publish repository password
# it can be overriden by env variable ORG_GRADLE_PROJECT_mavenRepoPass
# it can be overridden by env variable ORG_GRADLE_PROJECT_mavenRepoPass
mavenRepoPass=
123 changes: 123 additions & 0 deletions ...odpi/openmetadata/accessservices/assetmanager/api/exchange/GlossaryExchangeInterface.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ String createGlossary(String userId,
* @param externalIdentifierProperties optional properties used to define an external identifier
* @param templateGUID unique identifier of the metadata element to copy
* @param templateProperties properties that override the template
* @param deepCopy should the template creation extend to the anchored elements or just the direct entity?
*
* @return unique identifier of the new metadata element
*
Expand All @@ -85,6 +86,7 @@ String createGlossaryFromTemplate(String userId,
boolean assetManagerIsHome,
String templateGUID,
ExternalIdentifierProperties externalIdentifierProperties,
boolean deepCopy,
TemplateProperties templateProperties) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;
Expand Down Expand Up @@ -122,6 +124,65 @@ void updateGlossary(String userId,
PropertyServerException;


/**
* Classify the glossary to indicate that it is an editing glossary - this means it is
* a temporary collection of glossary updates that will be merged into another glossary.
*
* @param userId calling user
* @param assetManagerGUID unique identifier of software capability representing the caller
* @param assetManagerName unique name of software capability representing the caller
* @param glossaryGUID unique identifier of the metadata element to remove
* @param glossaryExternalIdentifier unique identifier of the glossary in the external asset manager
* @param properties description of the purpose of the editing glossary
* @param effectiveTime the time that the retrieved elements must be effective for
* @param forLineage return elements marked with the Memento classification?
* @param forDuplicateProcessing do not merge elements marked as duplicates?
*
* @throws InvalidParameterException one of the parameters is invalid
* @throws UserNotAuthorizedException the user is not authorized to issue this request
* @throws PropertyServerException there is a problem reported in the open metadata server(s)
*/
void setGlossaryAsEditingGlossary(String userId,
String assetManagerGUID,
String assetManagerName,
String glossaryGUID,
String glossaryExternalIdentifier,
EditingGlossaryProperties properties,
Date effectiveTime,
boolean forLineage,
boolean forDuplicateProcessing) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;


/**
* Remove the editing glossary classification from the glossary.
*
* @param userId calling user
* @param assetManagerGUID unique identifier of software capability representing the caller
* @param assetManagerName unique name of software capability representing the caller
* @param glossaryGUID unique identifier of the metadata element to remove
* @param glossaryExternalIdentifier unique identifier of the glossary in the external asset manager
* @param effectiveTime the time that the retrieved elements must be effective for
* @param forLineage return elements marked with the Memento classification?
* @param forDuplicateProcessing do not merge elements marked as duplicates?
*
* @throws InvalidParameterException one of the parameters is invalid
* @throws UserNotAuthorizedException the user is not authorized to issue this request
* @throws PropertyServerException there is a problem reported in the open metadata server(s)
*/
void clearGlossaryAsEditingGlossary(String userId,
String assetManagerGUID,
String assetManagerName,
String glossaryGUID,
String glossaryExternalIdentifier,
Date effectiveTime,
boolean forLineage,
boolean forDuplicateProcessing) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;


/**
* Classify the glossary to indicate that it can be used as a taxonomy.
* This means each term is attached to one, and only one category and the categories are organized as a hierarchy
Expand Down Expand Up @@ -448,6 +509,7 @@ String createGlossaryCategory(String userId,
* @param glossaryGUID unique identifier of the glossary where the category is located
* @param templateGUID unique identifier of the metadata element to copy
* @param externalIdentifierProperties optional properties used to define an external identifier
* @param deepCopy should the template creation extend to the anchored elements or just the direct entity?
* @param templateProperties properties that override the template
*
* @return unique identifier of the new glossary category
Expand All @@ -463,6 +525,7 @@ String createGlossaryCategoryFromTemplate(String userId,
String glossaryGUID,
String templateGUID,
ExternalIdentifierProperties externalIdentifierProperties,
boolean deepCopy,
TemplateProperties templateProperties) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;
Expand Down Expand Up @@ -857,6 +920,7 @@ String createControlledGlossaryTerm(String userId,
* @param glossaryGUID unique identifier of the glossary where the term is located
* @param templateGUID unique identifier of the metadata element to copy
* @param externalIdentifierProperties optional properties used to define an external identifier
* @param deepCopy should the template creation extend to the anchored elements or just the direct entity?
* @param templateProperties properties that override the template
*
* @return unique identifier of the new metadata element for the glossary term
Expand All @@ -872,6 +936,7 @@ String createGlossaryTermFromTemplate(String userId,
String glossaryGUID,
String templateGUID,
ExternalIdentifierProperties externalIdentifierProperties,
boolean deepCopy,
TemplateProperties templateProperties) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;
Expand Down Expand Up @@ -1147,6 +1212,64 @@ void clearTermAsAbstractConcept(String userId,
PropertyServerException;


/**
* Classify the glossary term to indicate that it describes a data field and supply
* properties that describe the characteristics of the data values found within.
*
* @param userId calling user
* @param assetManagerGUID unique identifier of software capability representing the caller
* @param assetManagerName unique name of software capability representing the caller
* @param glossaryTermGUID unique identifier of the metadata element to update
* @param glossaryTermExternalIdentifier unique identifier of the glossary term in the external asset manager
* @param effectiveTime the time that the retrieved elements must be effective for
* @param forLineage return elements marked with the Memento classification?
* @param forDuplicateProcessing do not merge elements marked as duplicates?
*
* @throws InvalidParameterException one of the parameters is invalid
* @throws UserNotAuthorizedException the user is not authorized to issue this request
* @throws PropertyServerException there is a problem reported in the open metadata server(s)
*/
void setTermAsDataField(String userId,
String assetManagerGUID,
String assetManagerName,
String glossaryTermGUID,
String glossaryTermExternalIdentifier,
DataFieldValuesProperties properties,
Date effectiveTime,
boolean forLineage,
boolean forDuplicateProcessing) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;


/**
* Remove the data field designation from the glossary term.
*
* @param userId calling user
* @param assetManagerGUID unique identifier of software capability representing the caller
* @param assetManagerName unique name of software capability representing the caller
* @param glossaryTermGUID unique identifier of the metadata element to update
* @param glossaryTermExternalIdentifier unique identifier of the glossary term in the external asset manager
* @param effectiveTime the time that the retrieved elements must be effective for
* @param forLineage return elements marked with the Memento classification?
* @param forDuplicateProcessing do not merge elements marked as duplicates?
*
* @throws InvalidParameterException one of the parameters is invalid
* @throws UserNotAuthorizedException the user is not authorized to issue this request
* @throws PropertyServerException there is a problem reported in the open metadata server(s)
*/
void clearTermAsDataField(String userId,
String assetManagerGUID,
String assetManagerName,
String glossaryTermGUID,
String glossaryTermExternalIdentifier,
Date effectiveTime,
boolean forLineage,
boolean forDuplicateProcessing) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException;


/**
* Classify the glossary term to indicate that it describes a data value.
*
Expand Down
Loading

0 comments on commit ea12067

Please sign in to comment.