com.ihr.xbrl.om.quality

Interface QualityCheck<T extends XBRLPlugInProcessor>

Type Parameters:

T - the generic type

All Known Subinterfaces:

QualityCheckIx<T>

All Known Implementing Classes:

ESEF_1_1_1, ESEF_1_4_1, ESEF_2_1_1, ESEF_2_1_2, ESEF_2_1_3_a, ESEF_2_1_3_b, ESEF_2_1_4, ESEF_2_2_1, ESEF_2_2_2, ESEF_2_2_3, ESEF_2_2_4, ESEF_2_3_1_a, ESEF_2_3_1_b, ESEF_2_3_1_c, ESEF_2_3_1_d, ESEF_2_4_1, ESEF_2_4_2, ESEF_2_5_1_a, ESEF_2_5_1_b, ESEF_2_5_2, ESEF_2_5_3, ESEF_2_5_4, ESEF_2_6_1, ESEF_3_1_1, ESEF_3_1_5, ESEF_3_2_1, ESEF_3_2_2, ESEF_3_2_3, ESEF_3_2_4, ESEF_3_2_5, ESEF_3_3_2, ESEF_3_4_2_a, ESEF_3_4_2_b, ESEF_3_4_2_c, ESEF_3_4_2_d, ESEF_3_4_2_e, ESEF_3_4_3_a, ESEF_3_4_3_b, ESEF_3_4_4, ESEF_3_4_5_a, ESEF_3_4_5_b, ESEF_3_4_6, ESEF_3_5_1, ESEF_RTS_Art_6_a, ESEF_RTS_II_p1, ESEF_RTS_IV_p4_1, ESEF_RTS_IV_p4_2, ESEF_RTS_IV_p7, ESEF_RTS_IV_p8, ESEFIxRule, ESEFRule, ESEFRuleContext, ESEFRuleFact, ESEFRuleFootnote, FRTA_2_1_1, FRTA_2_1_10, FRTA_2_1_11, FRTA_2_1_18, FRTA_2_1_2, FRTA_2_1_3, FRTA_2_1_4, FRTA_2_1_5, FRTA_2_1_8, FRTA_2_3_6, FRTA_2_3_7, FRTA_2_3_9, FRTA_3_1_1, FRTA_3_1_11, FRTA_3_1_13, FRTA_3_1_14, FRTA_3_1_2, FRTA_3_1_3, FRTA_3_1_5, FRTA_3_1_7, FRTA_3_2_3, FRTA_3_2_6, FRTA_3_3_5, FRTA_3_3_6, FRTA_4_2_1, FRTA_4_2_11, FRTA_4_2_2, FRTA_4_2_4, FRTA_4_2_5, FRTA_4_2_6, FRTA_4_2_7, FRTA_4_3_2, FRTA_5_1_6, FRTA_5_1_9, FRTA_rule, QualityCheckBaseImpl, RS_6_2_1, RS_6_3_1, RS_7_1_1, RS_7_2_1, RS_8_1_1, RS_rule

public interface QualityCheck<T extends XBRLPlugInProcessor>

Interface contract to describe a class that can perform quality checks on a DTS based on specific rules such are checking if all concepts has a label for the standard role and things like that.

At static startup of an FRTAProcessor all classes implementing this tag interface are collected and made available to the FRTAProcessor to perform validation

Every class must contain documentation to allow the user to understand what the class will be checking

Validation will add subclasses of XBRLInconsistency not errors

Every validation will incorporate the rule code that generated the inconsistency

Instances of QualityCheck interface shall be state-less and perform validation during the call to validate method. This is not mandatory as QualityCkeckIx extension of this interface is state-full until validate is called

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
QualityCheckProviderLibrary<T>	getLibrary() Obtains the library the rule belongs to.
T	getProcessor() Obtains the instance of the QualityProcessor where this QualityCheck will be running.
java.lang.String	getRuleCode() Every rule must have a code such as 2.3.6 Rule codes are static information
java.lang.String	getRuleDescription() Every rule must have a rule description that explains what the rule is doing.
java.lang.String	getRuleName() Every rule must have a short rule name to be used in rule enumerations in the GUI.
boolean	isDefaultEnabled() This method is used when the user has not enabled or disabled a rule The default values are static.
boolean	isEnabled() This method returns true if the rule is enabled or false if the rule is disabled.
void	setLibrary(QualityCheckProviderLibrary<T> library) Sets the library the rule belongs to.
void	setProcessor(T processor) Assigns the QualityProcessor instance.
XBRLValidationReport	validate(T processor) Performs validation for the rule and returns an XBRLValidationReport with the rule results.

Method Detail

getRuleCode

java.lang.String getRuleCode()

Every rule must have a code such as 2.3.6

Rule codes are static information

Returns:

the static rule code

getRuleName

java.lang.String getRuleName()

Every rule must have a short rule name to be used in rule enumerations in the GUI.

Returns:

the rule name

getRuleDescription

java.lang.String getRuleDescription()

Every rule must have a rule description that explains what the rule is doing. The rule description can be used in the GUI as long text or as tool tip.

The rule Description must be html

Returns:

the rule description

validate

XBRLValidationReport validate(T processor)

Performs validation for the rule and returns an XBRLValidationReport with the rule results.

Parameters:

processor - instance of the FRTAProcessor to be used

Returns:

XBRLValidationReport with potentially new XBRLInconsistency instances

isEnabled

boolean isEnabled()

This method returns true if the rule is enabled or false if the rule is disabled.

Returns:

boolean indicating if the rule is enabled

isDefaultEnabled

boolean isDefaultEnabled()

This method is used when the user has not enabled or disabled a rule The default values are static.

Returns:

boolean indicated the static value

getLibrary

QualityCheckProviderLibrary<T> getLibrary()

Obtains the library the rule belongs to.

Returns:

instance of QualityCheckProviderLibrary that contains the QualityCheck rule

setLibrary

void setLibrary(QualityCheckProviderLibrary<T> library)

Sets the library the rule belongs to. This method is used internally every time a new instance of a rule is created and allows the code to call getLibrary()

Parameters:

library - the new library

getProcessor

T getProcessor()

Obtains the instance of the QualityProcessor where this QualityCheck will be running.

Returns:

QualityProcessor instance

setProcessor

void setProcessor(T processor)

Assigns the QualityProcessor instance.

Parameters:

processor - the new processor