Merge pull request #8719 from mandy-chessell/oak2025

Add mermaid graphs to glossary elements

Author: mandy-chessell

CloudInformationModelGUIDMap.json

@@ -30,6 +30,8 @@ public class ResultsRequestBody
     private Date                asOfTime               = null;
     private SequencingOrder     sequencingOrder        = null;
     private String              sequencingProperty     = null;
+    private TemplateFilter      templateFilter         = null;
+
 
     /**
      * Default constructor
@@ -56,6 +58,7 @@ public ResultsRequestBody(ResultsRequestBody template)
             asOfTime               = template.getAsOfTime();
             sequencingOrder        = template.getSequencingOrder();
             sequencingProperty     = template.getSequencingProperty();
+            templateFilter         = template.getTemplateFilter();
         }
     }
 
@@ -220,6 +223,28 @@ public void setSequencingOrder(SequencingOrder sequencingOrder)
     }
 
 
+    /**
+     * Return the setting of the template filter.
+     *
+     * @return TemplateFilter enum
+     */
+    public TemplateFilter getTemplateFilter()
+    {
+        return templateFilter;
+    }
+
+
+    /**
+     *  Set up the setting of the template filter.
+     *
+     * @param templateFilter enum
+     */
+    public void setTemplateFilter(TemplateFilter templateFilter)
+    {
+        this.templateFilter = templateFilter;
+    }
+
+
     /**
      * JSON-style toString
      *
@@ -236,6 +261,7 @@ public String toString()
                 ", asOfTime=" + asOfTime +
                 ", sequencingOrder=" + sequencingOrder +
                 ", sequencingProperty='" + sequencingProperty + '\'' +
+                ", templateFilter=" + templateFilter +
                 '}';
     }
 
@@ -258,6 +284,7 @@ public boolean equals(Object objectToCompare)
                 Objects.equals(limitResultsByStatus, that.limitResultsByStatus) &&
                 Objects.equals(asOfTime, that.asOfTime) &&
                 sequencingOrder == that.sequencingOrder &&
+                templateFilter == that.templateFilter &&
                 Objects.equals(sequencingProperty, that.sequencingProperty);
     }
 
@@ -271,7 +298,7 @@ public boolean equals(Object objectToCompare)
     @Override
     public int hashCode()
     {
-        return Objects.hash(forLineage, forDuplicateProcessing, effectiveTime,
+        return Objects.hash(forLineage, forDuplicateProcessing, effectiveTime, templateFilter,
                             limitResultsByStatus, asOfTime, sequencingOrder, sequencingProperty);
     }
 }

content-packs/CloudInformationModel.omarchive

@@ -0,0 +1,29 @@
+/* SPDX-License-Identifier: Apache-2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+package org.odpi.openmetadata.commonservices.ffdc.rest;
+
+
+/**
+ * Defines the options to filter out templates
+ */
+public enum TemplateFilter
+{
+    /**
+     * Ignore any element that is either classified with the Template classification, or the TemplateSubstitute
+     * classification.
+     */
+    NO_TEMPLATES,
+
+    /**
+     * Only return elements that are classified with the Template classification, or the TemplateSubstitute
+     * classification.
+     */
+    ONLY_TEMPLATES,
+
+    /**
+     * Return all matching elements irrespective of whether they have the Template classification, or the
+     * TemplateSubstitute classification.
+     */
+    ALL
+}

open-metadata-implementation/common-services/ffdc-services/src/main/java/org/odpi/openmetadata/commonservices/ffdc/rest/ResultsRequestBody.java

@@ -562,7 +562,7 @@ private List<B> getValidCategories(String             userId,
 
 
     /**
-     * Convert the returned glossary category entities into a list of glossary term elements.
+     * Convert the returned glossary category entities into a list of glossary category elements.
      *
      * @param userId calling user
      * @param relatedCategories list of entities returned
@@ -603,7 +603,7 @@ private List<B> getRelatedGlossaryCategoryBeans(String              userId,
 
 
     /**
-     * Convert the returned glossary term entity into an element.
+     * Convert the returned glossary category entities into an element.
      *
      * @param userId calling user
      * @param categoryEntities entities returned
@@ -643,7 +643,7 @@ private List<B> getGlossaryCategoryBeans(String             userId,
 
 
     /**
-     * Convert the returned glossary term entity into an element.
+     * Convert the returned glossary category entity into an element.
      *
      * @param userId calling user
      * @param categoryEntity entity returned

open-metadata-implementation/common-services/ffdc-services/src/main/java/org/odpi/openmetadata/commonservices/ffdc/rest/TemplateFilter.java

@@ -2,15 +2,24 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 package org.odpi.openmetadata.commonservices.generichandlers;
 
-import org.odpi.openmetadata.commonservices.generichandlers.OMFConverter;
+import org.odpi.openmetadata.commonservices.mermaid.GlossaryMermaidGraphBuilder;
+import org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException;
+import org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ChildCategoryElement;
 import org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GlossaryElement;
+import org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedMetadataElementSummary;
 import org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryProperties;
-import org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException;
-import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.*;
+import org.odpi.openmetadata.frameworks.openmetadata.types.OpenMetadataType;
+import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail;
+import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties;
+import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship;
 import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory;
 import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper;
 
 import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 /**
  * GlossaryConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS)
@@ -34,19 +43,23 @@ public GlossaryConverter(OMRSRepositoryHelper repositoryHelper,
 
 
     /**
-     * Using the supplied instances, return a new instance of the bean. This is used for beans that
-     * contain a combination of the properties from an entity and that of a connected relationship.
+     * Using the supplied instances, return a new instance of the bean.
      *
      * @param beanClass name of the class to create
-     * @param entity entity containing the properties
+     * @param primaryEntity entity that is the root of the collection of entities that make up the
+     *                      content of the bean
+     * @param relationship relationship used to access the entity
+     * @param relatedEntities relationships linking the entities
      * @param methodName calling method
      * @return bean populated with properties from the instances supplied
      * @throws PropertyServerException there is a problem instantiating the bean
      */
-    @Override
-    public B getNewBean(Class<B>     beanClass,
-                        EntityDetail entity,
-                        String       methodName) throws PropertyServerException
+    public B getNewComplexBean(Class<B>            beanClass,
+                               EntityDetail        primaryEntity,
+                               Relationship        relationship,
+                               List<RelatedEntity> relatedEntities,
+                               String              methodName) throws PropertyServerException
+
     {
         try
         {
@@ -57,16 +70,16 @@ public B getNewBean(Class<B>     beanClass,
 
             if (returnBean instanceof GlossaryElement bean)
             {
-                GlossaryProperties glossaryProperties = new GlossaryProperties();
 
-                if (entity != null)
+                if (primaryEntity != null)
                 {
-                    bean.setElementHeader(this.getMetadataElementHeader(beanClass, entity, methodName));
+                    bean.setElementHeader(this.getMetadataElementHeader(beanClass, primaryEntity, methodName));
+                    GlossaryProperties glossaryProperties = new GlossaryProperties();
 
                     /*
                      * The initial set of values come from the entity.
                      */
-                    InstanceProperties instanceProperties = new InstanceProperties(entity.getProperties());
+                    InstanceProperties instanceProperties = new InstanceProperties(primaryEntity.getProperties());
 
                     glossaryProperties.setQualifiedName(this.removeQualifiedName(instanceProperties));
                     glossaryProperties.setAdditionalProperties(this.removeAdditionalProperties(instanceProperties));
@@ -76,6 +89,102 @@ public B getNewBean(Class<B>     beanClass,
                     glossaryProperties.setUsage(this.removeUsage(instanceProperties));
 
                     bean.setGlossaryProperties(glossaryProperties);
+
+                    if (relatedEntities != null)
+                    {
+                        List<RelatedMetadataElementSummary> externalReferences     = new ArrayList<>();
+                        Map<String, ChildCategoryElement>   categories             = new HashMap<>();
+                        List<RelatedEntity>                 categoryHierarchyLinks = new ArrayList<>();
+                        List<String>                        childCategories        = new ArrayList<>();
+                        List<RelatedMetadataElementSummary> otherRelatedElements   = new ArrayList<>();
+
+                        for (RelatedEntity relatedEntity : relatedEntities)
+                        {
+                            if ((relatedEntity != null) && (relatedEntity.relationship() != null) && (relatedEntity.entityDetail() != null))
+                            {
+                                if (repositoryHelper.isTypeOf(serviceName,
+                                                              relatedEntity.relationship().getType().getTypeDefName(),
+                                                              OpenMetadataType.CATEGORY_ANCHOR_RELATIONSHIP.typeName))
+                                {
+                                    ChildCategoryElement childCategoryElement = new ChildCategoryElement(super.getRelatedMetadataElementSummary(beanClass, relatedEntity, methodName));
+
+                                    categories.put(childCategoryElement.getRelatedElement().getElementHeader().getGUID(), childCategoryElement);
+                                }
+                                else if (repositoryHelper.isTypeOf(serviceName,
+                                                                   relatedEntity.relationship().getType().getTypeDefName(),
+                                                                   OpenMetadataType.CATEGORY_HIERARCHY_LINK_RELATIONSHIP.typeName))
+                                {
+                                    categoryHierarchyLinks.add(relatedEntity);
+                                }
+                                else if (repositoryHelper.isTypeOf(serviceName,
+                                                                   relatedEntity.relationship().getType().getTypeDefName(),
+                                                                   OpenMetadataType.EXTERNAL_REFERENCE_LINK_RELATIONSHIP.typeName))
+                                {
+                                    externalReferences.add(super.getRelatedMetadataElementSummary(beanClass, relatedEntity, methodName));
+                                }
+                                else if (! repositoryHelper.isTypeOf(serviceName,
+                                                                   relatedEntity.relationship().getType().getTypeDefName(),
+                                                                   OpenMetadataType.TERM_ANCHOR_RELATIONSHIP.typeName))
+                                {
+                                    otherRelatedElements.add(super.getRelatedMetadataElementSummary(beanClass, relatedEntity, methodName));
+                                }
+                            }
+                        }
+
+                        if (! categoryHierarchyLinks.isEmpty())
+                        {
+                            for (RelatedEntity relatedEntity : categoryHierarchyLinks)
+                            {
+                                ChildCategoryElement parentCategory = categories.get(relatedEntity.relationship().getEntityOneProxy().getGUID());
+                                ChildCategoryElement childCategory  = categories.get(relatedEntity.relationship().getEntityTwoProxy().getGUID());
+
+                                if ((parentCategory != null) && (childCategory != null))
+                                {
+                                    List<ChildCategoryElement> currentChildCategories = parentCategory.getChildCategories();
+
+                                    if (currentChildCategories == null)
+                                    {
+                                        currentChildCategories = new ArrayList<>();
+                                    }
+
+                                    currentChildCategories.add(childCategory);
+                                    parentCategory.setChildCategories(currentChildCategories);
+                                    childCategories.add(childCategory.getRelatedElement().getElementHeader().getGUID());
+                                }
+                            }
+                        }
+
+                        if (! externalReferences.isEmpty())
+                        {
+                            bean.setExternalReferences(externalReferences);
+                        }
+                        if (! categories.isEmpty())
+                        {
+                            /*
+                             * Only need to return the top-level categories - all other
+                             * categories are nested.
+                             */
+                            List<ChildCategoryElement> parentCategories = new ArrayList<>();
+
+                            for (ChildCategoryElement categoryElement : categories.values())
+                            {
+                                if (! childCategories.contains(categoryElement.getRelatedElement().getElementHeader().getGUID()))
+                                {
+                                    parentCategories.add(categoryElement);
+                                }
+                            }
+
+                            bean.setCategories(parentCategories);
+                        }
+                        if (! otherRelatedElements.isEmpty())
+                        {
+                            bean.setOtherRelatedElements(otherRelatedElements);
+                        }
+                    }
+
+                    GlossaryMermaidGraphBuilder graphBuilder = new GlossaryMermaidGraphBuilder(bean);
+
+                    bean.setMermaidGraph(graphBuilder.getMermaidGraph());
                 }
                 else
                 {
@@ -94,6 +203,25 @@ public B getNewBean(Class<B>     beanClass,
     }
 
 
+    /**
+     * Using the supplied instances, return a new instance of the bean. This is used for beans that
+     * contain a combination of the properties from an entity and that of a connected relationship.
+     *
+     * @param beanClass name of the class to create
+     * @param entity entity containing the properties
+     * @param methodName calling method
+     * @return bean populated with properties from the instances supplied
+     * @throws PropertyServerException there is a problem instantiating the bean
+     */
+    @Override
+    public B getNewBean(Class<B>     beanClass,
+                        EntityDetail entity,
+                        String       methodName) throws PropertyServerException
+    {
+        return getNewComplexBean(beanClass, entity, (Relationship) null, null, methodName);
+    }
+
+
     /**
      * Using the supplied instances, return a new instance of the bean. This is used for beans that
      * contain a combination of the properties from an entity and that of a connected relationship.
@@ -111,6 +239,6 @@ public B getNewBean(Class<B>     beanClass,
                         Relationship relationship,
                         String       methodName) throws PropertyServerException
     {
-        return getNewBean(beanClass, entity, methodName);
+        return getNewComplexBean(beanClass, entity, relationship, null, methodName);
     }
 }