Package com.orchestranetworks.addon.dqid

Class DefaultDECIndicator

java.lang.Object

com.orchestranetworks.addon.dqid.Indicator

com.orchestranetworks.addon.dqid.DECIndicator

com.orchestranetworks.addon.dqid.DefaultDECIndicator

All Implemented Interfaces:

IndicatorDefinition, Cloneable

public abstract class DefaultDECIndicator
extends DECIndicator
implements IndicatorDefinition

Provides default implementations for optional properties of an IndicatorDefinition, and allows users to define the behavior of a DECIndicator.

Since:

1.5.2

See Also:

• DECIndicator
• IndicatorDefinition

Constructor Summary

Constructors

Constructor	Description
DefaultDECIndicator()

Method Summary

Modifier and Type	Method	Description
BigDataDefinition	getBigDataDefinition()	Returns null.
com.onwbp.base.text.UserMessage	getDashboardLabel()	Returns a user message from the label.
DECSubType	getDECSubType()	Returns null.
com.onwbp.base.text.UserMessage	getDescription()	Returns an empty message.
final Indicator	getImplementation()	Returns an instance of the indicator.
List<ParameterDefinition>	getInputParametersDefinition()	Returns an empty list of ParameterDefinition.
com.onwbp.base.text.UserMessage	getLabel()	Returns a user message from the code.
LinkedRecordDefinition	getLinkedRecordDefinition()	Returns null.
Set<FrequencyType>	getPossibleComputationFrequencies()	Returns the on-demand and real-time types.
Set<ProbeType>	getPossibleProbes()	Returns an empty set of ProbeType.
com.onwbp.base.text.UserMessage	getStorageProcedureInformation()	Returns an empty message.
WatchdogInformation	getWatchdogInformation()	Returns null.
boolean	hasManyOutcomesStoredInBigDataTable()	Deprecated. Since 2.0.0, use IndicatorDefinition.hasManyOutcomesStoredInReportingTable() instead.
boolean	hasManyOutcomesStoredInReportingTable()	Returns false.
boolean	isLinkedRecordVisibleOnIndicatorOnDECTable(com.onwbp.adaptation.Adaptation record)	Returns true.
boolean	isLinkedRecordVisibleOnIndicatorTable()	Returns true.
boolean	isTableFilterPredicateSupported()	Returns true if this indicator is at the table, group, or field level.

Methods inherited from class com.orchestranetworks.addon.dqid.DECIndicator

execute

Methods inherited from class com.orchestranetworks.addon.dqid.Indicator

getDefinition, getFlatDataAccessor, getIndicatorDefinitionContext, getIndicatorReportAccessor, getPrimaryKeyOrNullOfExistingIndicatorReport, getPrimaryKeyOrNullOfExistingIndicatorReportInBigDataTable, getPrimaryKeysOfExistingIndicatorValueParts

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orchestranetworks.addon.dqid.IndicatorDefinition

getCode, getDECType, getFlatDataDefinition, getOutputParametersDefinition

Constructor Details

DefaultDECIndicator

public DefaultDECIndicator()

Method Details

getLabel

public com.onwbp.base.text.UserMessage getLabel()

Returns a user message from the code.

Specified by:

getLabel in interface IndicatorDefinition

See Also:

• IndicatorDefinition.getCode()

getDashboardLabel

public com.onwbp.base.text.UserMessage getDashboardLabel()

Returns a user message from the label.

Specified by:

getDashboardLabel in interface IndicatorDefinition

See Also:

• IndicatorDefinition.getLabel()

getDescription

public com.onwbp.base.text.UserMessage getDescription()

Returns an empty message.

Specified by:

getDescription in interface IndicatorDefinition

getImplementation

public final Indicator getImplementation()

Returns an instance of the indicator.

Specified by:

getImplementation in interface IndicatorDefinition

See Also:

• IndicatorDefinition.getImplementation()

getDECSubType

public DECSubType getDECSubType()

Returns null.

Specified by:

getDECSubType in interface IndicatorDefinition

See Also:

• DECSubType

getStorageProcedureInformation

public com.onwbp.base.text.UserMessage getStorageProcedureInformation()

Returns an empty message.

Specified by:

getStorageProcedureInformation in interface IndicatorDefinition

getWatchdogInformation

public WatchdogInformation getWatchdogInformation()

Returns null.

Specified by:

getWatchdogInformation in interface IndicatorDefinition

See Also:

• WatchdogInformation

hasManyOutcomesStoredInBigDataTable

@Deprecated
public boolean hasManyOutcomesStoredInBigDataTable()

Deprecated.

Since 2.0.0, use IndicatorDefinition.hasManyOutcomesStoredInReportingTable() instead.

Returns false.

Specified by:

hasManyOutcomesStoredInBigDataTable in interface IndicatorDefinition

hasManyOutcomesStoredInReportingTable

public boolean hasManyOutcomesStoredInReportingTable()

Returns false.

Specified by:

hasManyOutcomesStoredInReportingTable in interface IndicatorDefinition

Since:

2.0.0

getInputParametersDefinition

public List<ParameterDefinition> getInputParametersDefinition()

Returns an empty list of ParameterDefinition.

Specified by:

getInputParametersDefinition in interface IndicatorDefinition

See Also:

• ParameterDefinition

getPossibleComputationFrequencies

public Set<FrequencyType> getPossibleComputationFrequencies()

Returns the on-demand and real-time types.

Specified by:

getPossibleComputationFrequencies in interface IndicatorDefinition

See Also:

• FrequencyType

getPossibleProbes

public Set<ProbeType> getPossibleProbes()

Returns an empty set of ProbeType.

Specified by:

getPossibleProbes in interface IndicatorDefinition

See Also:

• ProbeType

getLinkedRecordDefinition

public LinkedRecordDefinition getLinkedRecordDefinition()

Returns null.

Specified by:

getLinkedRecordDefinition in interface IndicatorDefinition

Returns:

Returns null if this indicator doesn't need to store the relevant records.

See Also:

• LinkedRecordDefinition

isLinkedRecordVisibleOnIndicatorOnDECTable

public boolean isLinkedRecordVisibleOnIndicatorOnDECTable(com.onwbp.adaptation.Adaptation record)

Returns true.

Specified by:

isLinkedRecordVisibleOnIndicatorOnDECTable in interface IndicatorDefinition

Since:

2.5.0

See Also:

• LinkedRecordDefinition

isLinkedRecordVisibleOnIndicatorTable

public boolean isLinkedRecordVisibleOnIndicatorTable()

Returns true.

Specified by:

isLinkedRecordVisibleOnIndicatorTable in interface IndicatorDefinition

Since:

2.5.0

See Also:

• LinkedRecordDefinition

getBigDataDefinition

public BigDataDefinition getBigDataDefinition()

Returns null.

Specified by:

getBigDataDefinition in interface IndicatorDefinition

Since:

2.0.0

See Also:

• BigDataDefinition

isTableFilterPredicateSupported

public boolean isTableFilterPredicateSupported()

Returns true if this indicator is at the table, group, or field level.

Specified by:

isTableFilterPredicateSupported in interface IndicatorDefinition

Since:

2.1.0