Package com.orchestranetworks.addon.dqid

Class IndicatorReport

java.lang.Object
com.orchestranetworks.addon.dqid.IndicatorReport
public final class IndicatorReport extends Object
The Java Bean container an Indicator's outcomes.
See Also:

  • Constructor Details

    • IndicatorReport

      public IndicatorReport()

  • Method Details

    • addValue

      public void addValue(IndicatorValue indicatorValue)
      Adds an IndicatorValue.

    • addValues

      public void addValues(List<IndicatorValue> indicatorValues)
      Adds several IndicatorValue.
      Since:
      1.3.0

    • getExecutionDate

      public Date getExecutionDate()
      Returns the time when executing indicator.

    • getIndicatorDefinitionCode

      public String getIndicatorDefinitionCode()
      Returns the unique code of an IndicatorDefinition.
      Since:
      1.5.2

    • getIndicatorDefinitionClass

      public String getIndicatorDefinitionClass()
      Deprecated.
      Returns the definition class of an IndicatorDefinition.

      Since v1.5.2, a definition class can be shared between multiple instances of IndicatorDefinition. The unique code is used to identify an indicator definition instead.

      See Also:

    • getIndicatorValues

      public List<IndicatorValue> getIndicatorValues()
      Returns the list of IndicatorValue, the atomic outcomes after executing Indicator.

    • isAlertRaisedByWatchdog

      public boolean isAlertRaisedByWatchdog()

      Returns true if Watchdog is considered as an alert to save IndicatorReport.

      It is applied only on indicators which have WatchdogInformation.

    • isAutomatic

      public boolean isAutomatic()
      Returns true if the indicator runs on probe (trigger).

    • setAlertRaisedByWatchdog

      public void setAlertRaisedByWatchdog(boolean alertRaisedByWatchdog)
      Parameters:
      alertRaisedByWatchdog - boolean
      See Also:

    • getPrimaryKeyOfPreviousIndicatorReport

      public com.onwbp.adaptation.PrimaryKey getPrimaryKeyOfPreviousIndicatorReport()

      Returns the primary key of the last corresponding record in the Indicator report table if IndicatorDefinitionContext.saveLastValueOnlyOnReportingTable() returns true.

      Otherwise, it returns null.

    • setPrimaryKeyOfPreviousIndicatorReport

      public void setPrimaryKeyOfPreviousIndicatorReport(com.onwbp.adaptation.PrimaryKey primaryKeyOfPreviousIndicatorReport)
      Defines the primary key of the previous indicator report, used for updates.

    • getPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder

      public com.onwbp.adaptation.PrimaryKey getPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder(int sequence, int order)

      Returns the primary key of the last corresponding record in the Indicator value table if IndicatorDefinitionContext.saveLastValueOnlyOnReportingTable() returns true.

      Otherwise, returns null.

      The received primary key is based on IndicatorValue.getSequence() and IndicatorValue.getOrder().

      Parameters:
      sequence - integer
      order - integer

    • setPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder

      public void setPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder(int sequence, Map<Integer,com.onwbp.adaptation.PrimaryKey> primaryKeysByOrder)
      Defines the primary keys of previous indicator values, used for updates.

    • getPrimaryKeyOfPreviousBigDataBySequence

      public com.onwbp.adaptation.PrimaryKey getPrimaryKeyOfPreviousBigDataBySequence(int sequence)
      Deprecated.

      Returns the primary key of the last corresponding record in Big data table if IndicatorDefinitionContext.saveLastValueOnlyOnBigDataTable() returns true.

      Otherwise, it returns null.

      The received primary key is based on IndicatorValue.getSequence().

      Since 2.0.0, use getPrimaryKeyOfPreviousReportingRecordBySequence(int) instead.

      Parameters:
      sequence - integer

    • setPrimaryKeyOfPreviousBigDataReportBySequence

      public void setPrimaryKeyOfPreviousBigDataReportBySequence(int sequence, com.onwbp.adaptation.PrimaryKey primaryKeyOfPreviousBigDataReport)
      Deprecated.

      Defines the primary key of the previous record in the Big data table.

      Since 2.0.0, use setPrimaryKeyOfPreviousReportingRecordBySequence(int, PrimaryKey) instead.

    • getPrimaryKeyOfPreviousReportingRecordBySequence

      public com.onwbp.adaptation.PrimaryKey getPrimaryKeyOfPreviousReportingRecordBySequence(int sequence)

      Returns the primary key of the last corresponding record in either the Big data or Flat data table depending on the IndicatorDefinition if IndicatorDefinitionContext.saveLastValueOnlyOnBigDataTable() is true.

      Otherwise, it returns null.

      The received primary key is based on IndicatorValue.getSequence().

      Parameters:
      sequence - integer
      Since:
      2.0.0

    • setPrimaryKeyOfPreviousReportingRecordBySequence

      public void setPrimaryKeyOfPreviousReportingRecordBySequence(int sequence, com.onwbp.adaptation.PrimaryKey primaryKey)
      Defines the primary key of the previous record in either the Big data or Flat data table depending on the IndicatorDefinition, used for updates.
      Parameters:
      sequence - integer
      primaryKey - PrimaryKey
      Since:
      2.0.0

    • noLinkedRecord

      public boolean noLinkedRecord()
      Returns true if there aren't any linked records.
      Since:
      1.4.0

    • getLinkedRecords

      public Iterator<Map.Entry<Integer,LinkedRecord>> getLinkedRecords()
      Returns the linked records mapped by sequences.
      Since:
      1.4.0

    • addLinkedRecord

      public void addLinkedRecord(int sequence, LinkedRecord linkedRecord)
      Adds linked records by a sequence.
      Since:
      1.4.0