Package org.odpi.openmetadata.adapters.connectors.reports.surveyreport

Class SurveyReportService

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService
org.odpi.openmetadata.adapters.connectors.reports.surveyreport.SurveyReportService
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension, org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService
public class SurveyReportService extends org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService
SurveyReportService extracts the requested survey report and turns it into a Markdown document.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SurveyReportService()
    Default Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAnnotationTitle(org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataElement annotationElement)
    Return the title to use on an annotation section of the report.
    String
    getAnnotationURL(org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataElement annotationElement)
    Return the URL to use to link to an annotation section of the report.
    void
    start()
    Indicates that the survey action service is completely configured and can begin processing.

    Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService

    disconnect, setGovernanceContext

    Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector

    getConnectorComponentDescription, initializeEmbeddedConnectors, setAuditLog, setGovernanceServiceName, validateContext

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, toString

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

    clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SurveyReportService

      public SurveyReportService()
      Default Constructor

  • Method Details

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Indicates that the survey action service is completely configured and can begin processing.
      Overrides:
      start in class org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the discovery service.

    • getAnnotationTitle

      public String getAnnotationTitle(org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataElement annotationElement)
      Return the title to use on an annotation section of the report.
      Parameters:
      annotationElement - element describing the annotation
      Returns:
      title string

    • getAnnotationURL

      public String getAnnotationURL(org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataElement annotationElement)
      Return the URL to use to link to an annotation section of the report.
      Parameters:
      annotationElement - element describing the annotation
      Returns:
      title string