Package com.orchestranetworks.addon.dqid

Class Indicator

java.lang.Object

com.orchestranetworks.addon.dqid.Indicator

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DECIndicator, WorkflowIndicator

public abstract class Indicator
extends Object
implements Cloneable

This abstract class must be extended to define the behavior of an indicator.

See Also:

• IndicatorDefinition

Constructor Summary

Constructors

Constructor	Description
Indicator()

Method Summary

Modifier and Type	Method	Description
final IndicatorDefinition	getDefinition()	Returns the IndicatorDefinition built for the Indicator.
final FlatDataAccessor	getFlatDataAccessor()	Returns the accessor to the Flat data report table or the Big data report table from IndicatorExecutionContext.
final IndicatorDefinitionContext	getIndicatorDefinitionContext()	Returns the IndicatorDefinitionContext as configured in the administration.
final IndicatorReportAccessor	getIndicatorReportAccessor()	Returns the accessor to the Indicator report table and the Indicator value table from IndicatorExecutionContext.
final com.onwbp.adaptation.PrimaryKey	getPrimaryKeyOrNullOfExistingIndicatorReport(IndicatorExecutionContext executionContext)	Deprecated. Since v2.0.0, use IndicatorReportAccessor.getPrimaryKeyOrNullOfLatestRecord(IndicatorExecutionContext) instead.
final com.onwbp.adaptation.PrimaryKey	getPrimaryKeyOrNullOfExistingIndicatorReportInBigDataTable(IndicatorExecutionContext executionContext, int sequence)	Deprecated. Since v2.0.0, use FlatDataAccessor.getPrimaryKeyOrNullOfLatestRecord(IndicatorExecutionContext, int) instead.
final Map<Integer,com.onwbp.adaptation.PrimaryKey>	getPrimaryKeysOfExistingIndicatorValueParts(com.onwbp.adaptation.PrimaryKey indicatorReportPK, IndicatorReport indicatorReport, int sequence)	Deprecated. Since v2.0.0, use IndicatorReportAccessor.getPrimaryKeysOfLatestIndicatorValues(PrimaryKey, IndicatorReport, int) instead.

Methods inherited from class java.lang.Object

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

Constructor Details

Indicator

public Indicator()

Method Details

getIndicatorDefinitionContext

public final IndicatorDefinitionContext getIndicatorDefinitionContext()

Returns the IndicatorDefinitionContext as configured in the administration.

getDefinition

public final IndicatorDefinition getDefinition()

Returns the IndicatorDefinition built for the Indicator.

getPrimaryKeyOrNullOfExistingIndicatorReport

public final com.onwbp.adaptation.PrimaryKey getPrimaryKeyOrNullOfExistingIndicatorReport(IndicatorExecutionContext executionContext)

Deprecated.

Since v2.0.0, use IndicatorReportAccessor.getPrimaryKeyOrNullOfLatestRecord(IndicatorExecutionContext) instead.

Returns the primary key of the last corresponding record in the Indicator report table.

Parameters:

executionContext - IndicatorExecutionContext

See Also:

• getIndicatorReportAccessor()
• IndicatorDefinitionContext.saveLastValueOnlyOnReportingTable()

getPrimaryKeysOfExistingIndicatorValueParts

public final Map<Integer,com.onwbp.adaptation.PrimaryKey> getPrimaryKeysOfExistingIndicatorValueParts(com.onwbp.adaptation.PrimaryKey indicatorReportPK,
 IndicatorReport indicatorReport,
 int sequence)
                                                                                               throws DQIdException

Deprecated.

Since v2.0.0, use IndicatorReportAccessor.getPrimaryKeysOfLatestIndicatorValues(PrimaryKey, IndicatorReport, int) instead.

Returns the mapping between the order (IndicatorValue.getOrder()) and the last corresponding record in the Indicator value table.

Parameters:

indicatorReportPK - result of method IndicatorReportAccessor.getPrimaryKeyOrNullOfLatestRecord(IndicatorExecutionContext)

indicatorReport - IndicatorReport

sequence - IndicatorValue.getSequence()

Throws:

DQIdException

See Also:

• getIndicatorReportAccessor()
• IndicatorDefinitionContext.saveLastValueOnlyInIndicatorReportTable()

getPrimaryKeyOrNullOfExistingIndicatorReportInBigDataTable

public final com.onwbp.adaptation.PrimaryKey getPrimaryKeyOrNullOfExistingIndicatorReportInBigDataTable(IndicatorExecutionContext executionContext,
 int sequence)
                                                                                                 throws DQIdException

Deprecated.

Since v2.0.0, use FlatDataAccessor.getPrimaryKeyOrNullOfLatestRecord(IndicatorExecutionContext, int) instead.

Returns the primary key of the last corresponding record in the Big data table.

Parameters:

executionContext - IndicatorExecutionContext

sequence - IndicatorValue.getSequence()

Throws:

DQIdException

See Also:

• getIndicatorReportAccessor()
• IndicatorDefinitionContext.saveLastValueOnlyOnBigDataTable()

getIndicatorReportAccessor

public final IndicatorReportAccessor getIndicatorReportAccessor()

Returns the accessor to the Indicator report table and the Indicator value table from IndicatorExecutionContext.

Since:

2.0.0

See Also:

• IndicatorExecutionContext

getFlatDataAccessor

public final FlatDataAccessor getFlatDataAccessor()

Returns the accessor to the Flat data report table or the Big data report table from IndicatorExecutionContext.

Since:

2.0.0

See Also:

• IndicatorExecutionContext