com.ihr.xbrl.om.assertions
Class XBRLAssertion

java.lang.Object
  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:

AssertionEvaluationLocal, EvaluableAssertion, StaticAssertionCheck, XBRLRelationshipPoint, XBRLMessageContext, HasFormulaProcessor, HasUncoveredAspectValueResolver, XBRLVariablesHolder, XMLEvaluationContextProvider, XBRLValidation, XBRLValueKey, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

Direct Known Subclasses:

XBRLExistenceAssertion, XBRLValueAssertion

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

Author:

Ignacio

Nested Class Summary

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, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, TYPE

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

CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

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

MODEL_DIMENSIONAL, MODEL_NON_DIMENSIONAL

Constructor Summary

XBRLAssertion(XBRLFormulaProcessor proc, XBRLExtendedLink parent, net.sf.saxon.s9api.XdmNode resNode)
Creates a new assertion from a node in an extended link.

XBRLAssertion(XBRLFormulaProcessor proc, XBRLResource other)
Assertions are normally created by copying another existing resource

Method Summary

XBRLAssertionResult[]	evaluateAssertion(XBRLInstance doc) Required for evaluating the assertion.
static java.lang.String	getAssertionID(XBRLResource resource) 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
XMLFragment	getEvaluationContext()
abstract java.lang.String	getExpression() Returns the assertion XPath expression
void	resetEvaluationContext()
void	staticCheck()

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

allDimensions, bindCycle, bindLastEvaluatedVariableValues, bindParameters, bindVariableValue, checkCyclicDependencies, compileFilters, compileFormulaExpression, declareVariables, getAspectModel, getBindableVariableNames, getFilters, getNumberOfVariables, getUncoveredAspectValue, getVariableResource, getVariableUse, getVariableValue, getVariableValue, isCovered, isImplicitFilter

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

getProcessor

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

addChild, clear, equals, generateLocatorToNode, generateNode, getAttributes, getDTSBase, getFriendlyName, getFriendlyName, getParent, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isOnValidation, isSimpleType, setComplexType, setDTSBase, setId, setParent, setRole, setRoleType, setSimpleType, setValue, validate

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

getActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo

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

addAttribute, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getElements, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isDead, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setValue, setVariablesDefined, toString, valueEquals, xEqual

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

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

getProcessor

Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLRelationshipPoint

addFromRelationship, addToRelationship, getFromRelationships, getToRelationships, removeFromRelationship, removeToRelationship

Constructor Detail

XBRLAssertion

public XBRLAssertion(XBRLFormulaProcessor proc,
                     XBRLExtendedLink parent,
                     net.sf.saxon.s9api.XdmNode resNode)
              throws XFValidationException

Creates a new assertion from a node in an extended link.

Parameters:

proc -

parent -

resNode -

Throws:

XFValidationException

XBRLAssertion

public XBRLAssertion(XBRLFormulaProcessor proc,
                     XBRLResource other)
              throws XFValidationException

Assertions are normally created by copying another existing resource

Parameters:

proc -

other -

Throws:

XFValidationException

Method Detail

evaluateAssertion

public XBRLAssertionResult[] evaluateAssertion(XBRLInstance doc)
                                        throws XFValidationException

Description copied from interface: EvaluableAssertion

Required for evaluating the assertion.

Specified by:

evaluateAssertion in interface EvaluableAssertion

Returns:

Throws:

XFValidationException

getEvaluationContext

public XMLFragment getEvaluationContext()

Specified by:

getEvaluationContext in interface XMLEvaluationContextProvider

resetEvaluationContext

public void resetEvaluationContext()

staticCheck

public void staticCheck()
                 throws XFValidationException

Throws:

XFValidationException

getAssertionID

public static java.lang.String getAssertionID(XBRLResource resource)

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

Returns:

the Assertion ID

getExpression

public abstract java.lang.String getExpression()

Returns the assertion XPath expression

Returns:

String