com.ihr.xbrl.om.formula

Class XBRLVariableFact

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

com.ihr.xbrl.om.formula.XBRLVariableFact

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasFormulaProcessor, XBRLVariableFormulaEvaluable, 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 XBRLVariableFact
extends XBRLVariableResource

The Class XBRLVariableFact.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

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

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	fallbackValue The Constant fallbackValue.
static javax.xml.namespace.QName	matches The Constant matches.
static javax.xml.namespace.QName	nils The Constant nils.
static javax.xml.namespace.QName	resourceName The Constant resourceName.

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

as, bindAsSequence, name, order

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
XBRLVariableFact(XBRLFormulaProcessor formulaProcessor, XBRLResource res) Instantiates a new XBRL variable fact.

Method Summary

Modifier and Type	Method and Description
boolean	bindAsEmpty(XBRLVariablesHolder set) Bind as empty.
boolean	checkVariable(XBRLVariablesHolder set, javax.xml.namespace.QName name, java.util.Collection<net.sf.saxon.s9api.QName> resolved) Check variable.
void	clear() Clear.
Evaluation	evaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars, XBRLVariableSetResource set) Evaluate value.
net.sf.saxon.s9api.XdmValue	fallbackValue(XBRLVariablesHolder set) Return the fallbackValue or null if no fallback value is possible on this variable.
java.util.Set<Aspect>	getCoveredAspects(XBRLVariablesHolder set) Gets the uncovered aspects.
java.lang.String	getExpression() Gets the expression.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.util.Collection<? extends net.sf.saxon.value.QNameValue>	getUncoveredDimensionalAspects() Gets the uncovered dimensional aspects.
java.util.Collection<? extends net.sf.saxon.value.StringValue>	getUncoveredNonDimensionalAspects(XBRLVariableSetResource set) Gets the uncovered non dimensional aspects.
java.util.Collection<javax.xml.namespace.QName>	getVariablesRequired(XBRLVariablesHolder set) Gets the variables required.
XMLFragment	getXMLFragment() Gets the XML fragment.
boolean	hasChildNodes()
boolean	isBindAsSequence() Checks if is bind as sequence.
boolean	isCoveredAspect(Aspect aspect) Checks if is covered aspect.
boolean	isMatches() Returns the explicit or default value of the matches attribute on the Fact Variable definition.
boolean	isUncovered(Aspect aspect, Aspect aspectDimension) Returns true if the aspect indicated is uncovered on the variable.
boolean	matcheable(net.sf.saxon.s9api.XdmValue value, XBRLVariablesHolder.ModelType aspectModel) Calculates if the sequence passed in as a parameter satisfy requirements to be split into sub-sequences by the VariablesLoopController who is the only one class that should call this method.
Evaluation	rawEvaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars) Raw evaluate value.
void	reset() Reset.

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

adjustValueAccordingToType, getAllAspectsFiltered, getFilters, getKeysAspectsFiltered, getUse, getVariableType, hasFilterAspect

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

getProcessor

Field Detail

resourceName

public static final javax.xml.namespace.QName resourceName

The Constant resourceName.

nils

public static final javax.xml.namespace.QName nils

The Constant nils.

matches

public static final javax.xml.namespace.QName matches

The Constant matches.

fallbackValue

public static final javax.xml.namespace.QName fallbackValue

The Constant fallbackValue.

Constructor Detail

XBRLVariableFact

public XBRLVariableFact(XBRLFormulaProcessor formulaProcessor,
                        XBRLResource res)
                 throws XFValidationException

Instantiates a new XBRL variable fact.

Parameters:

formulaProcessor - the formula processor

res - the res

Throws:

XFValidationException - the XF validation exception

Method Detail

isBindAsSequence

public boolean isBindAsSequence()

Checks if is bind as sequence.

Specified by:

isBindAsSequence in interface XBRLVariableFormulaEvaluable

Overrides:

isBindAsSequence in class XBRLVariableResource

Returns:

true, if is bind as sequence

checkVariable

public boolean checkVariable(XBRLVariablesHolder set,
                             javax.xml.namespace.QName name,
                             java.util.Collection<net.sf.saxon.s9api.QName> resolved)
                      throws XFValidationException

Check variable.

Parameters:

set - the set

name - the name

resolved - the resolved

Returns:

true, if successful

Throws:

XFValidationException - the XF validation exception

isMatches

public boolean isMatches()

Returns the explicit or default value of the matches attribute on the Fact Variable definition.

Returns:

boolean

rawEvaluateValue

public Evaluation rawEvaluateValue(XMLFragment evaluationContext,
                                   java.util.Collection<XBRLVariableResourceUse> availableVars)
                            throws XFValidationException

Raw evaluate value.

Parameters:

evaluationContext - the evaluation context

availableVars - the available vars

Returns:

the evaluation

Throws:

XFValidationException - the XF validation exception

evaluateValue

public Evaluation evaluateValue(XMLFragment evaluationContext,
                                java.util.Collection<XBRLVariableResourceUse> availableVars,
                                XBRLVariableSetResource set)
                         throws XFValidationException

Evaluate value.

Parameters:

evaluationContext - the evaluation context

availableVars - the available vars

set - the set

Returns:

the evaluation

Throws:

XFValidationException - the XF validation exception

See Also:

XBRLVariableFormulaEvaluable.rawEvaluateValue(XMLFragment, Collection)

reset

public void reset()

Reset.

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLVariableFormulaEvaluable

Overrides:

clear in class XBRLVariableResource

Throws:

java.lang.Throwable - the throwable

fallbackValue

public net.sf.saxon.s9api.XdmValue fallbackValue(XBRLVariablesHolder set)
                                          throws XFValidationException

Return the fallbackValue or null if no fallback value is possible on this variable.

Parameters:

set - the set

Returns:

the xdm value

Throws:

XFValidationException - the XF validation exception

bindAsEmpty

public boolean bindAsEmpty(XBRLVariablesHolder set)
                    throws XFValidationException

Bind as empty.

Parameters:

set - the set

Returns:

true, if successful

Throws:

XFValidationException - the XF validation exception

isCoveredAspect

public boolean isCoveredAspect(Aspect aspect)

Checks if is covered aspect.

Parameters:

aspect - the aspect

Returns:

true, if is covered aspect

getCoveredAspects

public java.util.Set<Aspect> getCoveredAspects(XBRLVariablesHolder set)

Gets the uncovered aspects.

Parameters:

set - the set

Returns:

the uncovered aspects

isUncovered

public boolean isUncovered(Aspect aspect,
                           Aspect aspectDimension)

Returns true if the aspect indicated is uncovered on the variable.

Parameters:

aspect - the aspect main. in case this is DIMENSION, the aspectDimension parameter indicates the actual dimension aspect to check for

aspectDimension - the dimension name as an Aspect instance

Returns:

true, if is uncovered

getVariablesRequired

public java.util.Collection<javax.xml.namespace.QName> getVariablesRequired(XBRLVariablesHolder set)

Gets the variables required.

Parameters:

set - the set

Returns:

the variables required

getUncoveredDimensionalAspects

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

Gets the uncovered dimensional aspects.

Returns:

the uncovered dimensional aspects

getUncoveredNonDimensionalAspects

public java.util.Collection<? extends net.sf.saxon.value.StringValue> getUncoveredNonDimensionalAspects(XBRLVariableSetResource set)

Gets the uncovered non dimensional aspects.

Parameters:

set - the set

Returns:

the uncovered non dimensional aspects

matcheable

public boolean matcheable(net.sf.saxon.s9api.XdmValue value,
                          XBRLVariablesHolder.ModelType aspectModel)
                   throws XFValidationException

Calculates if the sequence passed in as a parameter satisfy requirements to be split into sub-sequences by the VariablesLoopController who is the only one class that should call this method.

Parameters:

value - a sequence of 1 or more items that are values of a variable.

aspectModel - This is the variable set aspect model

Returns:

true or false. If true an iterator over the sequence will be created. true is then returned when all elements in the sequence contains the same values for all aspects. No value of the covered is used at this time.

Throws:

XFValidationException - the XF validation exception

getExpression

public java.lang.String getExpression()

Gets the expression.

Specified by:

getExpression in class XBRLVariableResource

Returns:

the expression

getXMLFragment

public XMLFragment getXMLFragment()

Gets the XML fragment.

Returns:

the XML fragment

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