com.ihr.xbrl.om

Class XBRLValidationImpl

java.lang.Object

com.ihr.xbrl.om.XBRLValidationImpl

All Implemented Interfaces:

XBRLValidation

public abstract class XBRLValidationImpl
extends java.lang.Object
implements XBRLValidation

This class implements XBRLValidation interface and adds a validation call back method that must be implemented by the parent class. It can be used inside objects that can be validated and all methods can be redirected to the instance of this class

Author:

Ignacio

Nested Class Summary

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Constructor Summary

Constructors

Constructor and Description
XBRLValidationImpl(XBRLValidation parent) Instantiates a new XBRL validation impl.

Method Summary

Methods

Modifier and Type	Method and Description
XBRLValidationReport	getValidationReport() Access to the last stored validation report.
void	invalidate() Invalidates the XBRLFact for XBRL validation.
boolean	invalidate(XBRLValidation.Direction dir) Invalidates this object and the elements in the XML tree according with the parameter in dir This method is used by GUI tools that requires to reset validation before a manual validation cycle is started.
boolean	isOnValidation() When validation is a recursive process, this function returns true if the object going to be validated is already under validation.
XBRLValidationReport	validate(XBRLPlugInProcessor proc) Executes validation on the instance object and returns a validation report.

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLValidationImpl

public XBRLValidationImpl(XBRLValidation parent)

Instantiates a new XBRL validation impl.

Parameters:

parent - the parent

Method Detail

getValidationReport

public XBRLValidationReport getValidationReport()

Description copied from interface: XBRLValidation

Access to the last stored validation report.

Specified by:

getValidationReport in interface XBRLValidation

Returns:

XBRLValidationReport or null if the object has not been validated or no errors exists

validate

public XBRLValidationReport validate(XBRLPlugInProcessor proc)

Description copied from interface: XBRLValidation

Executes validation on the instance object and returns a validation report.

The validation result may be cached internally. A call to XBRLValidation.invalidate(Direction) clears the validation cache.

Specified by:

validate in interface XBRLValidation

Parameters:

proc - the processor under which the object is going to be validated. Note the same object can be validated on multiple processors.

Returns:

the validation report or null if no errors.

invalidate

public void invalidate()

Invalidates the XBRLFact for XBRL validation.

This involved both directions UP and DOWN.

Specified by:

invalidate in interface XBRLValidation

Since:

2.6.6

invalidate

public boolean invalidate(XBRLValidation.Direction dir)

Description copied from interface: XBRLValidation

Invalidates this object and the elements in the XML tree according with the parameter in dir

This method is used by GUI tools that requires to reset validation before a manual validation cycle is started.

Specified by:

invalidate in interface XBRLValidation

Parameters:

dir - see the XBRLValidation.Direction enumeration for more information.

Returns:

true, if successful

isOnValidation

public boolean isOnValidation()

Description copied from interface: XBRLValidation

When validation is a recursive process, this function returns true if the object going to be validated is already under validation. This prevents a recursive loop to enter the same validation component in an infinite loop.

Specified by:

isOnValidation in interface XBRLValidation

Returns:

true if the document is under validation. Means, the validation has not finished.