com.ihr.xbrl.om.quality

Interface QualityCheckProviderLibrary<T extends XBRLPlugInProcessor>

Type Parameters:

T - the generic type

All Known Implementing Classes:

ESEFRulesLibrary, FRTAFactory, RSCHTQFactory

public interface QualityCheckProviderLibrary<T extends XBRLPlugInProcessor>

Factory class to create all quality check instances.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.lang.String	getProviderName() Returns a name associated with the package of quality checks.
QualityCheck<T>	getQualityCheck(java.lang.String ruleCode, T processor) Returns an instance of the quality check to be executed or null if the quality check provider library does not supports the quality check identified by rule code.
java.lang.String[]	getRuleCodes() Returns an array of rule codes on this library.
XBRLValidationReport	validate(T processor) Performs validation of the DTS for each one of the enabled rules in the library.

Method Detail

getProviderName

java.lang.String getProviderName()

Returns a name associated with the package of quality checks.

Returns:

the provider name

getRuleCodes

java.lang.String[] getRuleCodes()

Returns an array of rule codes on this library.

Returns:

the rule codes

getQualityCheck

QualityCheck<T> getQualityCheck(java.lang.String ruleCode,
                                T processor)
                         throws QualityCheckRuntimeException

Returns an instance of the quality check to be executed or null if the quality check provider library does not supports the quality check identified by rule code.

Parameters:

ruleCode - the quality check rule code

processor - the instance of the QualityProcessor this rule will be running for

Returns:

QualityCheck instance just created to be used once and destroyed

Throws:

QualityCheckRuntimeException - the quality check runtime exception

validate

XBRLValidationReport validate(T processor)

Performs validation of the DTS for each one of the enabled rules in the library.

Parameters:

processor - the instance of the QualityProcessor to obtain the DTSContainer and information to perform validation

Returns:

an instance of XBRLValidationReport populated with the validation results