com.ihr.xbrl.om.errors

Class XBRLAssertionResult

java.lang.Object

com.ihr.xbrl.om.errors.XBRLAssertionResult

All Implemented Interfaces:

LinkableErrorMessage, XBRLValidationErrorReport, java.lang.Comparable<XBRLAssertionResult>

public class XBRLAssertionResult
extends java.lang.Object
implements LinkableErrorMessage, java.lang.Comparable<XBRLAssertionResult>, XBRLValidationErrorReport

The Class XBRLAssertionResult. Implement Assertion Severity specification

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBRLAssertionResult.Severity The 3 available severities in the specification.

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

XBRLValidationErrorReport.ErrorSeverity, XBRLValidationErrorReport.ErrorValueKey

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assertionUnsatisfiedSeverityArcroleURI http://xbrl.org/arcrole/2016/assertion-unsatisfied-severity as defined in the specification
static javax.xml.namespace.QName	SeverityError The Constant SeverityError.
static javax.xml.namespace.QName	SeverityOK The Constant SeverityOK.
static javax.xml.namespace.QName	SeverityWarning The Constant SeverityWarning.

Constructor Summary

Constructors

Constructor and Description
XBRLAssertionResult(XBRLFormulaResource assertion, boolean result, int cycle, XBRLInstance inputInstance, XBRLInstance afterFormulaInstance) This method can be used to create an XBRLAssertionResult while looking if the XBRLAssertion contains a specific user defined message.

Method Summary

Modifier and Type	Method and Description
int	compareTo(XBRLAssertionResult o) Compare to.
boolean	equals(java.lang.Object obj) Equals.
XBRLInstance	getAfterFormulaInstance() Access to the XBRL Report that was created after the evaluation of the variable set Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS is false.
java.lang.String	getAssertionID() Gets the assertion id.
java.lang.String	getCustomCode() Access to the custom error code assigned to the assertion using Reporting Standard S.L. extension to assign custom error codes in the taxonomy for each assertion
XBRLFormulaResource	getEvaluatedResources() Access to the instance of the XBRLFormulaResource used during the assertion evaluation.
java.lang.String	getExpression() Gets the XPath expression that has been evaluated.
XBRLInstance	getInputInstance() Acess to the XBRL Input instance document on this assertion.
java.lang.String	getLinkableMessage(KeysForFactsProvider kp, LabelsProvider lp) Gets the linkable message.
java.lang.String	getMessage() Gets the message.
XBRLAssertionResult.Severity	getSeverity() Gets the severity.
TraceVariablesBind	getTraceVariables() If the API has stored information about variable binding for the evaluation of this assertion, this method returns that information at this time.
java.util.EnumMap<XBRLValidationErrorReport.ErrorValueKey,java.lang.Object>	getValidationReportData()
int	hashCode() Hash code.
boolean	isNotOk() Checks if is not ok.
boolean	isOK() Checks if is ok.
void	setExpression(java.lang.String expression) Sets the XPath expression that has been evaluated.
void	setTraceVariablesInformation(TraceVariablesBind info) The API uses this method to set the information about the variables that bind during the execution of thie assetion.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SeverityOK

public static final javax.xml.namespace.QName SeverityOK

The Constant SeverityOK.

SeverityWarning

public static final javax.xml.namespace.QName SeverityWarning

The Constant SeverityWarning.

SeverityError

public static final javax.xml.namespace.QName SeverityError

The Constant SeverityError.

assertionUnsatisfiedSeverityArcroleURI

public static final java.lang.String assertionUnsatisfiedSeverityArcroleURI

http://xbrl.org/arcrole/2016/assertion-unsatisfied-severity as defined in the specification

See Also:

Constant Field Values

Constructor Detail

XBRLAssertionResult

public XBRLAssertionResult(XBRLFormulaResource assertion,
                           boolean result,
                           int cycle,
                           XBRLInstance inputInstance,
                           XBRLInstance afterFormulaInstance)
                    throws XFValidationException

This method can be used to create an XBRLAssertionResult while looking if the XBRLAssertion contains a specific user defined message. If the message exist, the assertion message text will be evaluated and the text will be returned when the toString() method of this object is called and when a call to the getMessage() text is invoked. If the message does not exists, then the assertion will be created using a call to the constructor for assertionID and result parameters.

Parameters:

assertion - the assertion

result - the result

cycle - the cycle

inputInstance - the input instance

afterFormulaInstance - the after formula instance

Throws:

XFValidationException - the XF validation exception

Method Detail

getSeverity

public XBRLAssertionResult.Severity getSeverity()

Gets the severity. This is a value from the XBRLAssertionResult.Severity enumeration.

The severity value is set from the evaluation result. If the evaluation result has no assertionUnsatisfied arc to a resource, the severity is set to OK when the evaluation was true() and WARNING when the evaluation was false(). Otherwise the severity is set from the value of the resource associated

Returns:

the severity

getEvaluatedResources

public XBRLFormulaResource getEvaluatedResources()

Access to the instance of the XBRLFormulaResource used during the assertion evaluation. This method returns null when the value of the DTSCotainer property 'FORMULA_PROCESSOR_RETAIN_ASSERTION_RESOURCES' is 'false'. And may return a valid instance when the property value is 'true'

Returns:

XBRLFormulaResource or null

getAssertionID

public java.lang.String getAssertionID()

Gets the assertion id.

Returns:

the assertionID

isOK

public boolean isOK()

Checks if is ok.

Returns:

the result

isNotOk

public boolean isNotOk()

Checks if is not ok.

Returns:

the result

getMessage

public java.lang.String getMessage()

Gets the message.

Returns:

the message

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

getCustomCode

public java.lang.String getCustomCode()

Access to the custom error code assigned to the assertion using Reporting Standard S.L. extension to assign custom error codes in the taxonomy for each assertion

Returns:

custom error code or null if not set

getInputInstance

public XBRLInstance getInputInstance()

Acess to the XBRL Input instance document on this assertion.

Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS is false

Returns:

the inputInstance

setTraceVariablesInformation

public void setTraceVariablesInformation(TraceVariablesBind info)

The API uses this method to set the information about the variables that bind during the execution of thie assetion.

Parameters:

info - the new trace variables information

setExpression

public void setExpression(java.lang.String expression)

Sets the XPath expression that has been evaluated.

Parameters:

expression - the new expression

getExpression

public java.lang.String getExpression()

Gets the XPath expression that has been evaluated.

Returns:

the human readable expression or null if none was set

getTraceVariables

public TraceVariablesBind getTraceVariables()

If the API has stored information about variable binding for the evaluation of this assertion, this method returns that information at this time. Note, in order to activate tracing of variable binding the DTSContainer property FORMULA_PROCESSOR_RETAIN_USED_FACTS must be set to 'true' the default value is false.

This method returns null if no information exists

Returns:

the traceVariables

getAfterFormulaInstance

public XBRLInstance getAfterFormulaInstance()

Access to the XBRL Report that was created after the evaluation of the variable set

Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS is false.

Returns:

the afterFormulaInstance

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

getLinkableMessage

public java.lang.String getLinkableMessage(KeysForFactsProvider kp,
                                           LabelsProvider lp)

Gets the linkable message.

Specified by:

getLinkableMessage in interface LinkableErrorMessage

Parameters:

kp - the kp

lp - the lp

Returns:

the linkable message

compareTo

public int compareTo(XBRLAssertionResult o)

Compare to.

Specified by:

compareTo in interface java.lang.Comparable<XBRLAssertionResult>

Parameters:

o - the o

Returns:

the int

getValidationReportData

public java.util.EnumMap<XBRLValidationErrorReport.ErrorValueKey,java.lang.Object> getValidationReportData()

Specified by:

getValidationReportData in interface XBRLValidationErrorReport