com.ihr.xbrl.om.formula

Class XBRLFormula

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

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasFallbackValueResolver, HasFormulaProcessor, HasUncoveredAspectValueResolver, HasUncoveredDimensionalAspectsResolver, HasUncoveredNonDimensionalAspectsResolver, StaticCheck, 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 XBRLFormula
extends XBRLVariableSetResource
implements XMLEvaluationContextProvider, StaticCheck

The Class XBRLFormula.

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	decimals The Constant decimals.
static net.sf.saxon.s9api.QName	dimensionExplicit The Constant dimensionExplicit.
static net.sf.saxon.s9api.QName	dimensionTyped The Constant dimensionTyped.
static net.sf.saxon.s9api.QName	entityIdentifier The Constant entityIdentifier.
static javax.xml.namespace.QName	formula The Constant formula.
static net.sf.saxon.s9api.QName	formulaConcept The Constant formulaConcept.
static org.apache.log4j.Logger	log The log.
static net.sf.saxon.s9api.QName	occEmpty The Constant occEmpty.
static net.sf.saxon.s9api.QName	occFragments The Constant occFragments.
static net.sf.saxon.s9api.QName	occXPath The Constant occXPath.
static net.sf.saxon.s9api.QName	period The Constant period.
static javax.xml.namespace.QName	precision The Constant precision.
static javax.xml.namespace.QName	source The Constant source.
static javax.xml.namespace.QName	uncovered The Constant uncovered.
static net.sf.saxon.s9api.QName	unit The Constant unit.
static javax.xml.namespace.QName	value The Constant value.

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
XBRLFormula(XBRLFormulaProcessor proc, XBRLExtendedLink parent, XMLFragment node) Creates a new formula from a node in an extended link.
XBRLFormula(XBRLFormulaProcessor proc, XBRLResource other) Formulas are normally created by copying another existing resource.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLInstance	evaluateFormula(XBRLInstanceRootNode doc, XBRLInstance instance, XBRLEvaluationContext evalContext) Evaluates a formula and returns an instance document containing the formula output.
java.util.Set<Aspect>	getAllAspectsIndicated() Access to a bit map of flags for the aspects indicated on this formula.
XMLFragment	getEvaluationContext() Gets the evaluation context.
java.lang.String	getExpression() Access to the xpath expression inside this formula resource.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
TraceVariablesBind	getTraceVariablesBind() During the formula evaluation, this variable may be set to store a trace of variable bindings.
boolean	hasChildNodes()
boolean	isTheSourceOf(XBRLFact fact) This method returns true if this formula is the source of a fact generation.
void	setExecutionTarget(ExecutionTargetType type) Set or changes the target execution for this formula.
void	staticCheck() Static check.
void	staticCheckAspectRules() Called during the compilation of the resource.

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, getResource

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

getResource

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

getProcessor

Field Detail

log

public static org.apache.log4j.Logger log

The log.

value

public static final javax.xml.namespace.QName value

The Constant value.

source

public static final javax.xml.namespace.QName source

The Constant source.

decimals

public static final javax.xml.namespace.QName decimals

The Constant decimals.

precision

public static final javax.xml.namespace.QName precision

The Constant precision.

formula

public static final javax.xml.namespace.QName formula

The Constant formula.

uncovered

public static final javax.xml.namespace.QName uncovered

The Constant uncovered.

formulaConcept

public static final net.sf.saxon.s9api.QName formulaConcept

The Constant formulaConcept.

entityIdentifier

public static final net.sf.saxon.s9api.QName entityIdentifier

The Constant entityIdentifier.

period

public static final net.sf.saxon.s9api.QName period

The Constant period.

unit

public static final net.sf.saxon.s9api.QName unit

The Constant unit.

occEmpty

public static final net.sf.saxon.s9api.QName occEmpty

The Constant occEmpty.

occFragments

public static final net.sf.saxon.s9api.QName occFragments

The Constant occFragments.

occXPath

public static final net.sf.saxon.s9api.QName occXPath

The Constant occXPath.

dimensionExplicit

public static final net.sf.saxon.s9api.QName dimensionExplicit

The Constant dimensionExplicit.

dimensionTyped

public static final net.sf.saxon.s9api.QName dimensionTyped

The Constant dimensionTyped.

Constructor Detail

XBRLFormula

public XBRLFormula(XBRLFormulaProcessor proc,
                   XBRLExtendedLink parent,
                   XMLFragment node)
            throws XFValidationException

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

Parameters:

proc - the proc

parent - XBRLExtendedLink parent of this new formula

node - XMLFragment saxon node defined in saxon s9api

Throws:

XFValidationException - the XF validation exception

XBRLFormula

public XBRLFormula(XBRLFormulaProcessor proc,
                   XBRLResource other)
            throws XFValidationException

Formulas are normally created by copying another existing resource.

Parameters:

proc - the proc

other - XBRLResource

Throws:

XFValidationException - the XF validation exception

Method Detail

setExecutionTarget

public void setExecutionTarget(ExecutionTargetType type)

Set or changes the target execution for this formula. See the documentation of the ExecutionTargetType documentation. This method is used internally by the API.

Parameters:

type - the new execution target

staticCheck

public void staticCheck()
                 throws XFValidationException

Static check.

Specified by:

staticCheck in interface StaticCheck

Throws:

XFValidationException - the XF validation exception

staticCheckAspectRules

public void staticCheckAspectRules()
                            throws XFValidationException

Called during the compilation of the resource. This method implement the rules about checking the aspects for the formula and raise static errors if no aspect is found.

This method updates the internal variable allAspectsIndicated

Throws:

XFValidationException - the XF validation exception

See Also:

2.1.2 Aspect rules

getExpression

public java.lang.String getExpression()

Access to the xpath expression inside this formula resource.

Returns:

the expression

getAllAspectsIndicated

public java.util.Set<Aspect> getAllAspectsIndicated()

Access to a bit map of flags for the aspects indicated on this formula. Aspects should be used later for the implicit filters.

Returns:

the all aspects indicated

getTraceVariablesBind

public TraceVariablesBind getTraceVariablesBind()

During the formula evaluation, this variable may be set to store a trace of variable bindings. A new execution of this formula will reset this value

Returns:

the trace variables bind

evaluateFormula

public XBRLInstance evaluateFormula(XBRLInstanceRootNode doc,
                                    XBRLInstance instance,
                                    XBRLEvaluationContext evalContext)
                             throws XFValidationException

Evaluates a formula and returns an instance document containing the formula output.

Current version of the formula specification indicates that the formula output is just a single fact. In the opinion of the author of this code, this is just one sign of bad quality specifications.

Nothing would stop the formula authors to produce a sequence of facts as a result of a formula evaluation because the formula output can be easily enclosed inside a single instance document (containing one or a set of facts). This API has been designed this way in order to allow that possible feature in the future while provides the required functionality in the current document wording.

Parameters:

doc - the "target instance" as defined in the formula specification. This is the instance from which variable values will be obtained

instance - instance document to add generated facts to. This method will write values to instance. can be null, in this case, a new instance document is created inside this function.

evalContext - the eval context

Returns:

the instance parameter.

Throws:

XFValidationException - if errors occurs during the formula execution

See Also:

3 The processing model for formulae

getEvaluationContext

public XMLFragment getEvaluationContext()

Gets the evaluation context.

Specified by:

getEvaluationContext in interface XMLEvaluationContextProvider

Returns:

the evaluation context

isTheSourceOf

public boolean isTheSourceOf(XBRLFact fact)

This method returns true if this formula is the source of a fact generation. Note this method works only if the Execution Target is set for XBRL Consistency Checks

Parameters:

fact - the fact

Returns:

true or false

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