Package org.odpi.openmetadata.viewservices.automatedcuration.handlers

Class TechnologyTypeHandler

java.lang.Object
org.odpi.openmetadata.viewservices.automatedcuration.handlers.TechnologyTypeHandler
public class TechnologyTypeHandler extends Object
Provides additional support for retrieving technology types

  • Constructor Summary

    Constructors
    Constructor
    Description
    TechnologyTypeHandler(org.odpi.openmetadata.accessservices.assetowner.client.ExternalReferenceManager externalRefHandler, org.odpi.openmetadata.accessservices.assetowner.client.OpenMetadataStoreClient openHandler, String serviceName, String serverName)
    Construct the handler.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<TechnologyTypeSummary>
    findTechnologyTypes(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty)
    Locate valid values that match the search string.
    TechnologyTypeReport
    getTechnologyTypeDetail(String userId, String technologyTypeName, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty)
    Retrieve detailed information about a specific technology type.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ReferenceableElement>
    getTechnologyTypeElements(String userId, String technologyTypeName, boolean getTemplates, int startFrom, int pageSize, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty)
    Retrieve detailed information about a specific technology type.
    TechnologyTypeHierarchy
    getTechnologyTypeHierarchy(String userId, String technologyTypeName, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty)
    Retrieve the requested deployed implementation type metadata element and its subtypes.
    String
    getTechnologyTypeHierarchyMermaidString(TechnologyTypeHierarchy technologyTypeHierarchy)
    Return the mermaid graph for a technology type hierarchy.
    List<TechnologyTypeSummary>
    getTechnologyTypesForOpenMetadataType(String userId, String typeName, int startFrom, int pageSize, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty)
    Locate valid values that match the search string.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TechnologyTypeHandler

      public TechnologyTypeHandler(org.odpi.openmetadata.accessservices.assetowner.client.ExternalReferenceManager externalRefHandler, org.odpi.openmetadata.accessservices.assetowner.client.OpenMetadataStoreClient openHandler, String serviceName, String serverName)
      Construct the handler.
      Parameters:
      externalRefHandler - client for retrieving resources for a technology type
      openHandler - Open Metadata Store client
      serviceName - name of this component
      serverName - local server name

  • Method Details

    • findTechnologyTypes

      public List<TechnologyTypeSummary> findTechnologyTypes(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Locate valid values that match the search string. It considers the names, description, scope, usage and preferred value.
      Parameters:
      userId - calling user
      searchString - string value to look for
      startFrom - paging starting point
      pageSize - maximum number of return values.
      effectiveTime - the effective date/time to use for the query
      limitResultsByStatus - limit the status values that the elements should be
      asOfTime - repository time
      sequencingOrder - order of results
      sequencingProperty - optional property name
      Returns:
      list of valid value beans
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getTechnologyTypesForOpenMetadataType

      public List<TechnologyTypeSummary> getTechnologyTypesForOpenMetadataType(String userId, String typeName, int startFrom, int pageSize, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Locate valid values that match the search string. It considers the names, description, scope, usage and preferred value.
      Parameters:
      userId - calling user
      typeName - type name value to look for
      startFrom - paging starting point
      pageSize - maximum number of return values.
      effectiveTime - the effective date/time to use for the query
      limitResultsByStatus - limit the status values that the elements should be
      asOfTime - repository time
      sequencingOrder - order of results
      sequencingProperty - optional property name
      Returns:
      list of valid value beans
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getTechnologyTypeDetail

      public TechnologyTypeReport getTechnologyTypeDetail(String userId, String technologyTypeName, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve detailed information about a specific technology type. This includes templates, connectors and external references.
      Parameters:
      userId - calling user
      technologyTypeName - string value to look for
      effectiveTime - the effective date/time to use for the query
      limitResultsByStatus - limit the status values that the elements should be
      asOfTime - repository time
      sequencingOrder - order of results
      sequencingProperty - optional property name
      Returns:
      detailed report for technology type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getTechnologyTypeHierarchy

      public TechnologyTypeHierarchy getTechnologyTypeHierarchy(String userId, String technologyTypeName, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the requested deployed implementation type metadata element and its subtypes. A mermaid version if the hierarchy is also returned.
      Parameters:
      userId - calling user
      technologyTypeName - string value to look for
      effectiveTime - the effective date/time to use for the query
      limitResultsByStatus - limit the status values that the elements should be
      asOfTime - repository time
      sequencingOrder - order of results
      sequencingProperty - optional property name
      Returns:
      detailed report for technology type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getTechnologyTypeHierarchyMermaidString

      public String getTechnologyTypeHierarchyMermaidString(TechnologyTypeHierarchy technologyTypeHierarchy)
      Return the mermaid graph for a technology type hierarchy.
      Parameters:
      technologyTypeHierarchy - hierarchy to parse
      Returns:
      mermaid string or null

    • getTechnologyTypeElements

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ReferenceableElement> getTechnologyTypeElements(String userId, String technologyTypeName, boolean getTemplates, int startFrom, int pageSize, Date effectiveTime, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve detailed information about a specific technology type. This includes templates, connectors and external references.
      Parameters:
      userId - calling user
      technologyTypeName - string value to look for
      getTemplates - boolean indicating whether templates or non-template elements should be returned.
      startFrom - paging starting point
      pageSize - maximum number of return values.
      effectiveTime - the effective date/time to use for the query
      limitResultsByStatus - limit the status values that the elements should be
      asOfTime - repository time
      sequencingOrder - order of results
      sequencingProperty - optional property name
      Returns:
      detailed report for technology type
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.