Package com.orchestranetworks.addon.dqid

Class ReportingUtilities

java.lang.Object
com.orchestranetworks.addon.dqid.ReportingUtilities
public final class ReportingUtilities extends Object
Offers accessors to the reporting.
Since:
1.4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.onwbp.adaptation.Adaptation>
    getCorrelatedWatchdogIndicatorReports(com.onwbp.adaptation.Adaptation correlatedWatchdogReportRecord)
    Returns the Watchdog indicator report request result for a Correlated watchdog indicator report record.
    com.onwbp.adaptation.RequestResult
    getFlatDataResult(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate)
    Returns the request result from the Flat data report table by specifying a predicate.
    static ReportingUtilities
    getFromRepository(com.orchestranetworks.instance.Repository repository)
    Creates an instance of this class.
    com.onwbp.adaptation.RequestResult
    getRelevantRecords(com.onwbp.adaptation.Adaptation reportingRecord)
    Returns the Linked record request result for a Big data report or Flat data record.
    com.onwbp.adaptation.RequestResult
    getRelevantRecords(com.onwbp.adaptation.Adaptation reportingRecord, Collection<com.orchestranetworks.schema.Path> reportingPaths)
    Returns the Linked record request result for a Flat data report or Big data report record that matches the specified paths.
    com.onwbp.adaptation.RequestResult
    getResultOfBigDataReport(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate)
    Returns the request result from the Big data report table by specifying a predicate.
    com.onwbp.adaptation.RequestResult
    getResultOfIndicatorReport(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate)
    Returns the request result from the Indicator report table by specifying a predicate.
    com.onwbp.adaptation.RequestResult
    getResultOfIndicatorValue(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate)
    Returns the request result from the Indicator value by specifying a predicate.
    List<com.onwbp.adaptation.Adaptation>
    getWatchdogIndicatorReports(com.onwbp.adaptation.Adaptation reportingRecord)
    Returns the Watchdog indicator report request result for a Flat data report or Big data report record.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getFromRepository

      public static ReportingUtilities getFromRepository(com.orchestranetworks.instance.Repository repository)
      Creates an instance of this class.
      Parameters:
      repository - The current repository.

    • getResultOfBigDataReport

      public com.onwbp.adaptation.RequestResult getResultOfBigDataReport(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate) throws DQIdException
      Returns the request result from the Big data report table by specifying a predicate.
      Parameters:
      storageHomeKey - The HomeKey storage data space.
      storageDatasetName - The AdaptationName of the storage data set.
      predicate - The predicate to filter the Flat data report table.
      Throws:
      DQIdException - If the target storage is not found.

    • getFlatDataResult

      public com.onwbp.adaptation.RequestResult getFlatDataResult(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate) throws DQIdException
      Returns the request result from the Flat data report table by specifying a predicate.
      Parameters:
      storageHomeKey - The HomeKey storage data space.
      storageDatasetName - The AdaptationName of the storage data set.
      predicate - The predicate to filter the Flat data report table.
      Throws:
      DQIdException - If the target storage is not found.
      Since:
      2.0.0

    • getResultOfIndicatorReport

      public com.onwbp.adaptation.RequestResult getResultOfIndicatorReport(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate) throws DQIdException
      Returns the request result from the Indicator report table by specifying a predicate.
      Parameters:
      storageHomeKey - The HomeKey storage data space.
      storageDatasetName - The AdaptationName of the storage data set.
      predicate - The predicate to filter the Indicator report table.
      Throws:
      DQIdException - If the target storage is not found.

    • getResultOfIndicatorValue

      public com.onwbp.adaptation.RequestResult getResultOfIndicatorValue(com.orchestranetworks.instance.HomeKey storageHomeKey, com.onwbp.adaptation.AdaptationName storageDatasetName, String predicate) throws DQIdException
      Returns the request result from the Indicator value by specifying a predicate.
      Parameters:
      storageHomeKey - The HomeKey storage data space.
      storageDatasetName - The AdaptationName of the storage data set.
      predicate - The predicate to filter the Indicator value table.
      Throws:
      DQIdException - If the target storage is not found.

    • getRelevantRecords

      public com.onwbp.adaptation.RequestResult getRelevantRecords(com.onwbp.adaptation.Adaptation reportingRecord) throws DQIdException
      Returns the Linked record request result for a Big data report or Flat data record.
      Parameters:
      reportingRecord - The target reporting record.
      Throws:
      IllegalArgumentException - If the reporting record is not found.
      DQIdException
      See Also:

    • getRelevantRecords

      public com.onwbp.adaptation.RequestResult getRelevantRecords(com.onwbp.adaptation.Adaptation reportingRecord, Collection<com.orchestranetworks.schema.Path> reportingPaths)
      Returns the Linked record request result for a Flat data report or Big data report record that matches the specified paths.
      Parameters:
      reportingRecord - The target reporting record.
      reportingPaths - Reporting paths to filter Linked item records.
      Throws:
      IllegalArgumentException - If the reporting record is not found.

    • getWatchdogIndicatorReports

      public List<com.onwbp.adaptation.Adaptation> getWatchdogIndicatorReports(com.onwbp.adaptation.Adaptation reportingRecord)
      Returns the Watchdog indicator report request result for a Flat data report or Big data report record.
      Parameters:
      reportingRecord - The target reporting record.
      Throws:
      IllegalArgumentException - If the reporting record is not found.
      Since:
      1.5.0

    • getCorrelatedWatchdogIndicatorReports

      public List<com.onwbp.adaptation.Adaptation> getCorrelatedWatchdogIndicatorReports(com.onwbp.adaptation.Adaptation correlatedWatchdogReportRecord)
      Returns the Watchdog indicator report request result for a Correlated watchdog indicator report record.
      Parameters:
      correlatedWatchdogReportRecord - The target correlated watchdog report record.
      Throws:
      IllegalArgumentException - If the correlated watchdog report is not found.
      Since:
      1.5.0