com.ihr.xbrl.om.assertions

Class XBRLConsistencyAssertion

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship

com.ihr.xbrl.om.exLinks.XBRLResource

com.ihr.xbrl.om.formula.XBRLFormulaResource

com.ihr.xbrl.om.assertions.XBRLConsistencyAssertion

All Implemented Interfaces:

HasDTSContainer, AssertionEvaluationLocal, EvaluableAssertion, HasAssertionId, XBRLRelationshipPoint, XBRLMessageContext, HasFormulaProcessor, HasUncoveredAspectValueResolver, StaticCheck, XBRLVariablesHolder, HasChangeHashSupport, XBRLValidation, XBRLValueKey, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

public class XBRLConsistencyAssertion
extends XBRLFormulaResource
implements EvaluableAssertion, StaticCheck, AssertionEvaluationLocal, XBRLVariablesHolder, HasAssertionId, XBRLMessageContext, HasUncoveredAspectValueResolver

The Class XBRLConsistencyAssertion.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBRLConsistencyAssertion.ConsistencyAssertionType Indicates the type of the Consistency Assertion.
static class	XBRLConsistencyAssertion.XFConsistencyAssertionInvalidFact The Class XFConsistencyAssertionInvalidFact.

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

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

XBRLVariablesHolder.ModelType

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

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	absoluteAcceptanceRadiusQName The Constant absoluteAcceptanceRadiusQName.
static javax.xml.namespace.QName	ca_absolute_acceptance_radius_expression Used for the creation of messages.
static javax.xml.namespace.QName	ca_acceptance_radius Used for the creation of messages.
static javax.xml.namespace.QName	ca_aspect_matched_facts Used for the creation of messages.
static javax.xml.namespace.QName	ca_proportional_acceptance_radius_expression Used for the creation of messages.
static javax.xml.namespace.QName	proportionalAcceptanceRadiusQName The Constant proportionalAcceptanceRadiusQName.
static javax.xml.namespace.QName	resourceName The Constant resourceName.
static javax.xml.namespace.QName	strict The Constant strict.

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

nullResource

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

Fields inherited from class com.ihr.xbrl.om.XMLFragment

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XBRLConsistencyAssertion(XBRLFormulaProcessor proc, XBRLResource other) Instantiates a new XBRL consistency assertion.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
void	collectAssertionVariablenames(java.util.HashSet<javax.xml.namespace.QName> allVars) Collect assertion variablenames.
XBRLAssertionResult[]	evaluateAssertion(XBRLInstance doc, XBRLEvaluationContext evalContext) Evaluate assertion.
XBRLAssertionResult[]	evaluateAssertionType(XBRLInstance instance, XBRLEvaluationContext evalContext) Evaluate assertion type.
java.lang.String	getAbsoluteAcceptanceRadius() Gets the absolute acceptance radius.
XBRLVariablesHolder.ModelType	getAspectModel() Gets the aspect model.
net.sf.saxon.s9api.XdmItem	getAssertionContextItem() Gets the assertion context item.
java.lang.String	getAssertionID() Returns a text identifying the assertion from the linkbase syntax. this is either the value of the id attribute or the value of the xlink:label on the resource
java.util.Collection<? extends XBRLVariableResourceUse>	getAssertionMessageVariables() Gets the assertion message variables.
java.util.Collection<net.sf.saxon.s9api.QName>	getBindableVariableNames() Gets the bindable variable names.
XBRLConsistencyAssertion.ConsistencyAssertionType	getConsistencyAssertionType() Gets the consistency assertion type.
java.lang.String	getErrorIdentification() Gets the error identification.
java.lang.String	getExpression() Access to the xpath expression for this consistency assertion.
java.util.Collection<XBRLFilterUse>	getFilters() Gets the filters.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.lang.String	getProportionalAcceptanceRadius() Gets the proportional acceptance radius.
XBRLResource	getResource() Gets the resource.
net.sf.saxon.s9api.XdmValue	getUncoveredAspectValue(Aspect aspect, Aspect aspectDim) Gets the uncovered aspect value.
java.util.Collection<net.sf.saxon.value.QNameValue>	getUncoveredDimensionalAspects() Gets the uncovered dimensional aspects.
java.util.Collection<net.sf.saxon.value.StringValue>	getUncoveredNonDimensionalAspects() Gets the uncovered non dimensional aspects.
XBRLVariableFormulaEvaluable	getVariableResource(javax.xml.namespace.QName variableName) Gets the variable resource.
XBRLVariableResourceUse	getVariableUse(javax.xml.namespace.QName variableName) Obtains the instance of the XBRLVariableResourceUse on this variable set using the variable name.
net.sf.saxon.s9api.XdmValue	getVariableValue(javax.xml.namespace.QName variableName) Gets the variable value.
XFIImplicitFilterOptimizer	getXFIImplicitFilterOptimizer() Gets the XFI implicit filter optimizer.
boolean	hasChildNodes()
boolean	isImplicitFilter() Checks if is implicit filter.
boolean	isStrict() Checks if is strict.
void	setAbsoluteAcceptanceRadius(java.lang.String expression) Sets the absolute acceptance radius.
void	setProportionalAcceptanceRadius(java.lang.String expression) Sets the proportional acceptance radius.
void	staticCheck() Static check.

Methods inherited from class com.ihr.xbrl.om.formula.XBRLFormulaResource

addRequiredVariable, clearVariableSetDicoveredDuringExpressionCompilation, getProcessor, getRequiredVariableSetDiscoveredDuringExpressionCompilation

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

addChild, clone, clone, equals, generateNode, getAttributes, getCode, getDTSBase, getFriendlyName, getFriendlyName, getFriendlyName, getParentXBRL, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isHashDependsOnAtribute, isOnValidation, isSimpleType, setCode, setComplexType, setDTSBase, setId, setRawParentXBRL, setRole, setRoleType, setSimpleType, setValue, validate

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo, validateXPointer

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ihr.xbrl.om.assertions.EvaluableAssertion

getLabel

Methods inherited from interface com.ihr.xbrl.om.formula.HasFormulaProcessor

getProcessor

Field Detail

resourceName

public static final javax.xml.namespace.QName resourceName

The Constant resourceName.

proportionalAcceptanceRadiusQName

public static final javax.xml.namespace.QName proportionalAcceptanceRadiusQName

The Constant proportionalAcceptanceRadiusQName.

absoluteAcceptanceRadiusQName

public static final javax.xml.namespace.QName absoluteAcceptanceRadiusQName

The Constant absoluteAcceptanceRadiusQName.

strict

public static final javax.xml.namespace.QName strict

The Constant strict.

ca_aspect_matched_facts

public static final javax.xml.namespace.QName ca_aspect_matched_facts

Used for the creation of messages.

ca_acceptance_radius

public static final javax.xml.namespace.QName ca_acceptance_radius

Used for the creation of messages.

ca_absolute_acceptance_radius_expression

public static final javax.xml.namespace.QName ca_absolute_acceptance_radius_expression

Used for the creation of messages.

ca_proportional_acceptance_radius_expression

public static final javax.xml.namespace.QName ca_proportional_acceptance_radius_expression

Used for the creation of messages.

Constructor Detail

XBRLConsistencyAssertion

public XBRLConsistencyAssertion(XBRLFormulaProcessor proc,
                                XBRLResource other)
                         throws XFValidationException

Instantiates a new XBRL consistency assertion.

Parameters:

proc - the proc

other - the other

Throws:

XFValidationException - the XF validation exception

Method Detail

setProportionalAcceptanceRadius

public void setProportionalAcceptanceRadius(java.lang.String expression)

Sets the proportional acceptance radius.

Parameters:

expression - the new proportional acceptance radius

getProportionalAcceptanceRadius

public java.lang.String getProportionalAcceptanceRadius()

Gets the proportional acceptance radius.

Returns:

the String text expression in the proportionalAcceptanceRadius attribute or null if the attribute is not defined in the resource or has not been set using the setProportionalAcceptanceRadius(String) method

getAbsoluteAcceptanceRadius

public java.lang.String getAbsoluteAcceptanceRadius()

Gets the absolute acceptance radius.

Returns:

the String text expression in the absoluteAcceptanceRadius attribute or null if the attribute is not defined in the resource or has not been set using the setAbsoluteAcceptanceRadius(String) method

setAbsoluteAcceptanceRadius

public void setAbsoluteAcceptanceRadius(java.lang.String expression)

Sets the absolute acceptance radius.

Parameters:

expression - the new absolute acceptance radius

getConsistencyAssertionType

public XBRLConsistencyAssertion.ConsistencyAssertionType getConsistencyAssertionType()

Gets the consistency assertion type.

Returns:

the type of this consistency assertion derived from the content of the proportionalAcceptanceRadiusExpression and absoluteAcceptanceRadius attributes.

evaluateAssertionType

public XBRLAssertionResult[] evaluateAssertionType(XBRLInstance instance,
                                                   XBRLEvaluationContext evalContext)
                                            throws XFValidationException

Evaluate assertion type.

Specified by:

evaluateAssertionType in interface AssertionEvaluationLocal

Parameters:

instance - the instance

evalContext - the eval context

Returns:

the XBRL assertion result[]

Throws:

XFValidationException - the XF validation exception

getAssertionID

public java.lang.String getAssertionID()

Returns a text identifying the assertion from the linkbase syntax. this is either the value of the id attribute or the value of the xlink:label on the resource

Specified by:

getAssertionID in interface HasAssertionId

Returns:

the Assertion ID

staticCheck

public void staticCheck()
                 throws XFValidationException

Static check.

Specified by:

staticCheck in interface StaticCheck

Throws:

XFValidationException - the XF validation exception

isStrict

public boolean isStrict()

Checks if is strict.

Returns:

true, if is strict

getAspectModel

public XBRLVariablesHolder.ModelType getAspectModel()

Gets the aspect model.

Specified by:

getAspectModel in interface XBRLVariablesHolder

Returns:

the aspect model

getBindableVariableNames

public java.util.Collection<net.sf.saxon.s9api.QName> getBindableVariableNames()

Gets the bindable variable names.

Specified by:

getBindableVariableNames in interface XBRLVariablesHolder

Returns:

the bindable variable names

getFilters

public java.util.Collection<XBRLFilterUse> getFilters()

Gets the filters.

Specified by:

getFilters in interface XBRLVariablesHolder

Returns:

the filters

getVariableUse

public XBRLVariableResourceUse getVariableUse(javax.xml.namespace.QName variableName)

Obtains the instance of the XBRLVariableResourceUse on this variable set using the variable name.

The constructor of the XBRLVariableSetResource already calls readVariables so it is almost impossible this method raises XFRuntimeException

Specified by:

getVariableUse in interface XBRLMessageContext

Parameters:

variableName - the variable name

Returns:

instance of XBRLVariableResourceUse or null if none exist

getVariableResource

public XBRLVariableFormulaEvaluable getVariableResource(javax.xml.namespace.QName variableName)

Gets the variable resource.

Specified by:

getVariableResource in interface XBRLVariablesHolder

Parameters:

variableName - the variable name

Returns:

the variable resource

getVariableValue

public net.sf.saxon.s9api.XdmValue getVariableValue(javax.xml.namespace.QName variableName)
                                             throws XFValidationException

Gets the variable value.

Specified by:

getVariableValue in interface XBRLVariablesHolder

Parameters:

variableName - the variable name

Returns:

the variable value

Throws:

XFValidationException - the XF validation exception

getAssertionMessageVariables

public java.util.Collection<? extends XBRLVariableResourceUse> getAssertionMessageVariables()

Gets the assertion message variables.

Specified by:

getAssertionMessageVariables in interface XBRLMessageContext

Returns:

the assertion message variables

collectAssertionVariablenames

public void collectAssertionVariablenames(java.util.HashSet<javax.xml.namespace.QName> allVars)

Collect assertion variablenames.

Specified by:

collectAssertionVariablenames in interface XBRLMessageContext

Parameters:

allVars - the all vars

getAssertionContextItem

public net.sf.saxon.s9api.XdmItem getAssertionContextItem()

Gets the assertion context item.

Specified by:

getAssertionContextItem in interface XBRLMessageContext

Returns:

the assertion context item

getUncoveredAspectValue

public net.sf.saxon.s9api.XdmValue getUncoveredAspectValue(Aspect aspect,
                                                           Aspect aspectDim)
                                                    throws XFValidationException

Gets the uncovered aspect value.

Specified by:

getUncoveredAspectValue in interface XBRLMessageContext

Specified by:

getUncoveredAspectValue in interface HasUncoveredAspectValueResolver

Parameters:

aspect - the aspect

aspectDim - the aspect dim

Returns:

the uncovered aspect value

Throws:

XFValidationException - the XF validation exception

isImplicitFilter

public boolean isImplicitFilter()

Checks if is implicit filter.

Specified by:

isImplicitFilter in interface XBRLMessageContext

Specified by:

isImplicitFilter in interface HasUncoveredAspectValueResolver

Specified by:

isImplicitFilter in interface XBRLVariablesHolder

Returns:

true, if is implicit filter

getUncoveredDimensionalAspects

public java.util.Collection<net.sf.saxon.value.QNameValue> getUncoveredDimensionalAspects()

Gets the uncovered dimensional aspects.

Specified by:

getUncoveredDimensionalAspects in interface XBRLMessageContext

Returns:

the uncovered dimensional aspects

getUncoveredNonDimensionalAspects

public java.util.Collection<net.sf.saxon.value.StringValue> getUncoveredNonDimensionalAspects()

Gets the uncovered non dimensional aspects.

Specified by:

getUncoveredNonDimensionalAspects in interface XBRLMessageContext

Returns:

the uncovered non dimensional aspects

evaluateAssertion

public XBRLAssertionResult[] evaluateAssertion(XBRLInstance doc,
                                               XBRLEvaluationContext evalContext)
                                        throws XFValidationException

Evaluate assertion.

Specified by:

evaluateAssertion in interface EvaluableAssertion

Parameters:

doc - the doc

evalContext - the eval context

Returns:

the XBRL assertion result[]

Throws:

XFValidationException - the XF validation exception

getExpression

public java.lang.String getExpression()

Access to the xpath expression for this consistency assertion.

Returns:

String

getErrorIdentification

public java.lang.String getErrorIdentification()

Gets the error identification.

Specified by:

getErrorIdentification in interface EvaluableAssertion

Returns:

the error identification

getResource

public XBRLResource getResource()

Gets the resource.

Specified by:

getResource in interface EvaluableAssertion

Specified by:

getResource in interface XBRLVariablesHolder

Overrides:

getResource in class XBRLFormulaResource

Returns:

the resource

getXFIImplicitFilterOptimizer

public XFIImplicitFilterOptimizer getXFIImplicitFilterOptimizer()

Gets the XFI implicit filter optimizer.

Specified by:

getXFIImplicitFilterOptimizer in interface XBRLVariablesHolder

Returns:

the XFI implicit filter optimizer

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XBRLFormulaResource

Throws:

java.lang.Throwable - the throwable

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl

getNumberOfChildren

public final int getNumberOfChildren()

getFirstChild

public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>

Overrides:

getFirstChild in class net.sf.saxon.tree.linked.NodeImpl

getLastChild

public final net.sf.saxon.tree.linked.NodeImpl getLastChild()

Overrides:

getLastChild in class net.sf.saxon.tree.linked.NodeImpl