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

Class CategoryService

  • public class CategoryService
extends GlossaryViewOMAS
    Server-side implementation of the Glossary View Open Metadata Access Service (OMAS). Deals in extracting categories

    • Constructor Detail

      • CategoryService

        public CategoryService()

    • Method Detail

      • getCategory

        public GlossaryViewEntityDetailResponse getCategory​(String userId,
                                                    String serverName,
                                                    String categoryGUID)
        Extract the category definition for the given GUID
        Parameters:
        userId - calling user
        serverName - instance to call
        categoryGUID - category GUID
        Returns:
        EntityDetailResponse category

      • getCategoriesViaCategoryAnchorRelationships

        public GlossaryViewEntityDetailResponse getCategoriesViaCategoryAnchorRelationships​(String userId,
                                                                                    String serverName,
                                                                                    String glossaryGUID,
                                                                                    Integer from,
                                                                                    Integer size)
        Extract category definitions for the given glossary GUID via the 'CategoryAnchor' type relationships
        Parameters:
        userId - calling user
        serverName - instance to call
        glossaryGUID - glossary GUID
        from - offset start for the return values
        size - maximum number of results
        Returns:
        EntityDetailResponse all external glossaries

      • getSubcategories

        public GlossaryViewEntityDetailResponse getSubcategories​(String userId,
                                                         String serverName,
                                                         String categoryGUID,
                                                         Integer from,
                                                         Integer size)
        Extract subcategory definitions for the given category
        Parameters:
        userId - calling user
        serverName - instance to call
        categoryGUID - category GUID
        from - offset start for the return values
        size - maximum number of results
        Returns:
        EntityDetailResponse subcategories

      • getExternalGlossaryLinks

        public GlossaryViewEntityDetailResponse getExternalGlossaryLinks​(String userId,
                                                                 String serverName,
                                                                 String categoryGUID,
                                                                 Integer from,
                                                                 Integer size)
        Extract external glossary definitions for the given category
        Parameters:
        userId - calling user
        serverName - instance to call
        categoryGUID - glossary GUID
        from - offset start for the return values
        size - maximum number of results
        Returns:
        EntityDetailResponse all external glossaries

      • getAllCategories

        public GlossaryViewEntityDetailResponse getAllCategories​(String userId,
                                                         String serverName,
                                                         Integer from,
                                                         Integer size)
        Extract all categories 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