com.ihr.xbrl.om.assertions

Class XBRLValueAssertion

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.formula.XBRLVariableSetResource

com.ihr.xbrl.om.assertions.XBRLAssertion

com.ihr.xbrl.om.assertions.XBRLValueAssertion

All Implemented Interfaces:

HasDTSContainer, AssertionEvaluationLocal, EvaluableAssertion, HasAssertionId, StaticAssertionCheck, XBRLRelationshipPoint, XBRLMessageContext, HasFallbackValueResolver, HasFormulaProcessor, HasUncoveredAspectValueResolver, HasUncoveredDimensionalAspectsResolver, HasUncoveredNonDimensionalAspectsResolver, XBRLVariablesHolder, XMLEvaluationContextProvider, 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 XBRLValueAssertion
extends XBRLAssertion
implements HasAssertionId

The Class XBRLValueAssertion.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

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

XBRLVariableSetResource.PreconditionAndSelector

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	resourceName The Constant resourceName.
static javax.xml.namespace.QName	test The Constant test.
static javax.xml.namespace.QName	va_test_expression Used for the creation of messages.

Fields inherited from class com.ihr.xbrl.om.formula.XBRLVariableSetResource

aspectModel, implicitFiltering

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
XBRLValueAssertion(XBRLFormulaProcessor proc, XBRLResource other) Instantiates a new XBRL value 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[]	evaluateAssertionType(XBRLInstance instance, XBRLEvaluationContext evalContext) Evaluate assertion type.
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.lang.String	getErrorIdentification() Gets the error identification.
java.lang.String	getExpression() Gets the expression.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLResource	getResource() Gets the resource.
boolean	hasChildNodes()
void	staticAssertionCheck() Static assertion check.

Methods inherited from class com.ihr.xbrl.om.assertions.XBRLAssertion

evaluateAssertion, getEvaluationContext, getFriendlyName, getToolTipText, staticCheck

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

bindCycle, bindLastEvaluatedVariableValues, bindParameters, bindVariableValue, checkCyclicDependencies, compileFilters, compileFormulaExpression, declareVariables, evaluatePrecondition, evaluatePreconditions, getAspectModel, getBindableVariableNames, getCoveredAspectsSet, getFilters, getNumberOfVariables, getPreconditions, getUncoveredAspectValue, getUncoveredDimensionalAspects, getUncoveredNonDimensionalAspects, getVariableResource, getVariableResourceUses, getVariableUse, getVariableValue, getVariableValue, getVariableValue, getXFIImplicitFilterOptimizer, isCovered, isImplicitFilter

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, 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, 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.errors.XBRLMessageContext

getUncoveredAspectValue, getUncoveredDimensionalAspects, getUncoveredNonDimensionalAspects, getVariableUse, isImplicitFilter

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

getProcessor

Field Detail

test

public static final javax.xml.namespace.QName test

The Constant test.

resourceName

public static final javax.xml.namespace.QName resourceName

The Constant resourceName.

va_test_expression

public static final javax.xml.namespace.QName va_test_expression

Used for the creation of messages.

Constructor Detail

XBRLValueAssertion

public XBRLValueAssertion(XBRLFormulaProcessor proc,
                          XBRLResource other)
                   throws XFValidationException

Instantiates a new XBRL value assertion.

Parameters:

proc - the proc

other - the other

Throws:

XFValidationException - the XF validation exception

Method Detail

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

staticAssertionCheck

public void staticAssertionCheck()
                          throws XFValidationException

Static assertion check.

Specified by:

staticAssertionCheck in interface StaticAssertionCheck

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

getAssertionContextItem

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

Gets the assertion context item.

Specified by:

getAssertionContextItem in interface XBRLMessageContext

Returns:

the assertion context item

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

getExpression

public java.lang.String getExpression()

Gets the expression.

Specified by:

getExpression in class XBRLAssertion

Returns:

the expression

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

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XBRLVariableSetResource

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