Class IndicatorReport
- java.lang.Object
-
- com.orchestranetworks.addon.dqid.IndicatorReport
-
public final class IndicatorReport extends java.lang.Object
The Java Bean container anIndicator
's outcomes.
-
-
Constructor Summary
Constructors Constructor Description IndicatorReport()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addLinkedRecord(int sequence, LinkedRecord linkedRecord)
Adds linked records by a sequence.void
addValue(IndicatorValue indicatorValue)
Adds anIndicatorValue
.void
addValues(java.util.List<IndicatorValue> indicatorValues)
Adds severalIndicatorValue
.java.util.Date
getExecutionDate()
Returns the time when executing indicator.java.lang.String
getIndicatorDefinitionClass()
Deprecated.java.lang.String
getIndicatorDefinitionCode()
Returns the unique code of anIndicatorDefinition
.java.util.List<IndicatorValue>
getIndicatorValues()
Returns the list ofIndicatorValue
, the atomic outcomes after executing Indicator.java.util.Iterator<java.util.Map.Entry<java.lang.Integer,LinkedRecord>>
getLinkedRecords()
Returns the linked records mapped by sequences.com.onwbp.adaptation.PrimaryKey
getPrimaryKeyOfPreviousBigDataBySequence(int sequence)
Deprecated.com.onwbp.adaptation.PrimaryKey
getPrimaryKeyOfPreviousIndicatorReport()
Returns the primary key of the last corresponding record in theIndicator report
table ifIndicatorDefinitionContext.saveLastValueOnlyOnReportingTable()
returnstrue
.com.onwbp.adaptation.PrimaryKey
getPrimaryKeyOfPreviousReportingRecordBySequence(int sequence)
Returns the primary key of the last corresponding record in either theBig data
orFlat data
table depending on theIndicatorDefinition
ifIndicatorDefinitionContext.saveLastValueOnlyOnBigDataTable()
is true.com.onwbp.adaptation.PrimaryKey
getPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder(int sequence, int order)
Returns the primary key of the last corresponding record in theIndicator value
table ifIndicatorDefinitionContext.saveLastValueOnlyOnReportingTable()
returnstrue
.boolean
isAlertRaisedByWatchdog()
boolean
isAutomatic()
Returnstrue
if the indicator runs on probe (trigger).boolean
noLinkedRecord()
Returnstrue
if there aren't any linked records.void
setAlertRaisedByWatchdog(boolean alertRaisedByWatchdog)
void
setPrimaryKeyOfPreviousBigDataReportBySequence(int sequence, com.onwbp.adaptation.PrimaryKey primaryKeyOfPreviousBigDataReport)
Deprecated.void
setPrimaryKeyOfPreviousIndicatorReport(com.onwbp.adaptation.PrimaryKey primaryKeyOfPreviousIndicatorReport)
Defines the primary key of the previous indicator report, used for updates.void
setPrimaryKeyOfPreviousReportingRecordBySequence(int sequence, com.onwbp.adaptation.PrimaryKey primaryKey)
Defines the primary key of the previous record in either theBig data
orFlat data
table depending on theIndicatorDefinition
, used for updates.void
setPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder(int sequence, java.util.Map<java.lang.Integer,com.onwbp.adaptation.PrimaryKey> primaryKeysByOrder)
Defines the primary keys of previous indicator values, used for updates.
-
-
-
Method Detail
-
addValue
public void addValue(IndicatorValue indicatorValue)
Adds anIndicatorValue
.
-
addValues
public void addValues(java.util.List<IndicatorValue> indicatorValues)
Adds severalIndicatorValue
.- Since:
- 1.3.0
-
getExecutionDate
public java.util.Date getExecutionDate()
Returns the time when executing indicator.
-
getIndicatorDefinitionCode
public java.lang.String getIndicatorDefinitionCode()
Returns the unique code of anIndicatorDefinition
.- Since:
- 1.5.2
-
getIndicatorDefinitionClass
public java.lang.String getIndicatorDefinitionClass()
Deprecated.Returns the definition class of anIndicatorDefinition
.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:
getIndicatorDefinitionCode()
-
getIndicatorValues
public java.util.List<IndicatorValue> getIndicatorValues()
Returns the list ofIndicatorValue
, the atomic outcomes after executing Indicator.
-
isAlertRaisedByWatchdog
public boolean isAlertRaisedByWatchdog()
Returns
true
ifWatchdog
is considered as an alert to saveIndicatorReport
.It is applied only on indicators which have
WatchdogInformation
.
-
isAutomatic
public boolean isAutomatic()
Returnstrue
if the indicator runs on probe (trigger).
-
setAlertRaisedByWatchdog
public void setAlertRaisedByWatchdog(boolean alertRaisedByWatchdog)
- Parameters:
alertRaisedByWatchdog
-boolean
- See Also:
isAlertRaisedByWatchdog()
-
getPrimaryKeyOfPreviousIndicatorReport
public com.onwbp.adaptation.PrimaryKey getPrimaryKeyOfPreviousIndicatorReport()
Returns the primary key of the last corresponding record in the
Indicator report
table ifIndicatorDefinitionContext.saveLastValueOnlyOnReportingTable()
returnstrue
.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 ifIndicatorDefinitionContext.saveLastValueOnlyOnReportingTable()
returnstrue
.Otherwise, returns
null
.The received primary key is based on
IndicatorValue.getSequence()
andIndicatorValue.getOrder()
.- Parameters:
sequence
-integer
order
-integer
-
setPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder
public void setPrimaryKeysOfPreviousIndicatorValuesBySequenceAndOrder(int sequence, java.util.Map<java.lang.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 ifIndicatorDefinitionContext.saveLastValueOnlyOnBigDataTable()
returnstrue
.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
orFlat data
table depending on theIndicatorDefinition
ifIndicatorDefinitionContext.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 theBig data
orFlat data
table depending on theIndicatorDefinition
, used for updates.- Parameters:
sequence
-integer
primaryKey
-PrimaryKey
- Since:
- 2.0.0
-
noLinkedRecord
public boolean noLinkedRecord()
Returnstrue
if there aren't any linked records.- Since:
- 1.4.0
-
getLinkedRecords
public java.util.Iterator<java.util.Map.Entry<java.lang.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
-
-