com.ihr.xbrl.om.assertions

Class XBRLAssertion

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

All Implemented Interfaces:

HasDTSContainer, AssertionEvaluationLocal, EvaluableAssertion, 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

Direct Known Subclasses:

XBRLExistenceAssertion, XBRLValueAssertion

public abstract class XBRLAssertion
extends XBRLVariableSetResource
implements EvaluableAssertion, XMLEvaluationContextProvider, AssertionEvaluationLocal, StaticAssertionCheck, XBRLMessageContext

The Class XBRLAssertion.

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 inherited from class com.ihr.xbrl.om.formula.XBRLVariableSetResource

aspectModel, implicitFiltering, log

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
XBRLAssertion(XBRLFormulaProcessor proc, XBRLResource other) Assertions are normally created by copying another existing resource.

Method Summary

Modifier and Type	Method and Description
XBRLAssertionResult[]	evaluateAssertion(XBRLInstance doc, XBRLEvaluationContext evalContext) Evaluate assertion.
XMLFragment	getEvaluationContext() Gets the evaluation context.
abstract java.lang.String	getExpression() Returns the assertion XPath expression.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName(int modifiers) Gets the friendly name.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.lang.String	getToolTipText() Gets the tool tip text.
boolean	hasChildNodes()
void	staticCheck() Static check.

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

bindCycle, bindLastEvaluatedVariableValues, bindParameters, bindVariableValue, checkCyclicDependencies, clear, 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, getResource

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

getErrorIdentification, getLabel, getResource

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

evaluateAssertionType

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

staticAssertionCheck

Methods inherited from interface com.ihr.xbrl.om.formula.errors.XBRLMessageContext

collectAssertionVariablenames, getAssertionContextItem, getAssertionMessageVariables, getUncoveredAspectValue, getUncoveredDimensionalAspects, getUncoveredNonDimensionalAspects, getVariableUse, isImplicitFilter

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

getProcessor

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

getResource

Constructor Detail

XBRLAssertion

public XBRLAssertion(XBRLFormulaProcessor proc,
                     XBRLResource other)
              throws XFValidationException

Assertions are normally created by copying another existing resource.

Parameters:

proc - the proc

other - the other

Throws:

XFValidationException - the XF validation exception

Method Detail

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

getEvaluationContext

public XMLFragment getEvaluationContext()

Gets the evaluation context.

Specified by:

getEvaluationContext in interface XMLEvaluationContextProvider

Returns:

the evaluation context

staticCheck

public void staticCheck()
                 throws XFValidationException

Static check.

Throws:

XFValidationException - the XF validation exception

getExpression

public abstract java.lang.String getExpression()

Returns the assertion XPath expression.

Returns:

String

getToolTipText

public java.lang.String getToolTipText()

Gets the tool tip text.

Overrides:

getToolTipText in class XMLFragment

Returns:

the tool tip text

getFriendlyName

public java.lang.String getFriendlyName(int modifiers)

Description copied from class: XBRLResource

Gets the friendly name.

Overrides:

getFriendlyName in class XBRLResource

Parameters:

modifiers - the modifiers

Returns:

the friendly name

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