com.ihr.xbrl.om.formula

Class XBRLVariableResource

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

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

Direct Known Subclasses:

XBRLVariableFact, XBRLVariableGeneral, XBRLVariableParameter

public abstract class XBRLVariableResource
extends XBRLFormulaResource
implements XBRLVariableFormulaEvaluable

The Class XBRLVariableResource.

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	as The Constant as.
static javax.xml.namespace.QName	bindAsSequence The Constant bindAsSequence.
static javax.xml.namespace.QName	name The Constant name.
static javax.xml.namespace.QName	order The Constant 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
XBRLVariableResource(DTSContainer dts) Instantiates a new XBRL variable resource.
XBRLVariableResource(XBRLFormulaProcessor proc, XBRLExtendedLink parent, XMLFragment node) Instantiates a new XBRL variable resource.
XBRLVariableResource(XBRLFormulaProcessor proc, XBRLResource res) Instantiates a new XBRL variable resource.
XBRLVariableResource(XBRLFormulaResource other) Instantiates a new XBRL variable resource.

Method Summary

Modifier and Type	Method and Description
net.sf.saxon.s9api.XdmValue	adjustValueAccordingToType(net.sf.saxon.s9api.XdmValue val, net.sf.saxon.s9api.XdmItem item) Checks if the variable has a "as" attribute and: * if it exist; the value in the item parameter is converted to the type indicated * if it does not exist; the value of the val parameter is returned.
void	clear() Clear.
java.util.Set<Aspect>	getAllAspectsFiltered() Access to all aspects.
abstract java.lang.String	getExpression() Used only for debug purposes.
java.util.List<XBRLFilterUse>	getFilters(Aspect aspect) Gets the filters.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.util.Set<Aspect>	getKeysAspectsFiltered() Gets the keys aspects filtered.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
XBRLVariableResourceUse	getUse(XBRLRelationship rel, XBRLVariablesHolder set) Creates a new XBRLVariableResourceUse instance for this variable resource in the variable resource set.
XBRLVariableType	getVariableType() Gets the variable type.
boolean	hasChildNodes()
boolean	hasFilterAspect(Aspect aspectMain, Aspect aspectDimension) Checks for filter aspect.
boolean	isBindAsSequence() Checks if is bind as sequence.

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

checkVariable, evaluateValue, getProcessor, getVariablesRequired, getXMLFragment, rawEvaluateValue, reset

Field Detail

name

public static final javax.xml.namespace.QName name

The Constant name.

order

public static final javax.xml.namespace.QName order

The Constant order.

bindAsSequence

public static final javax.xml.namespace.QName bindAsSequence

The Constant bindAsSequence.

as

public static final javax.xml.namespace.QName as

The Constant as.

Constructor Detail

XBRLVariableResource

public XBRLVariableResource(DTSContainer dts)

Instantiates a new XBRL variable resource.

Parameters:

dts - the dts

XBRLVariableResource

public XBRLVariableResource(XBRLFormulaProcessor proc,
                            XBRLExtendedLink parent,
                            XMLFragment node)

Instantiates a new XBRL variable resource.

Parameters:

proc - the proc

parent - the parent

node - the res node

XBRLVariableResource

public XBRLVariableResource(XBRLFormulaProcessor proc,
                            XBRLResource res)

Instantiates a new XBRL variable resource.

Parameters:

proc - the proc

res - the res

XBRLVariableResource

public XBRLVariableResource(XBRLFormulaResource other)

Instantiates a new XBRL variable resource.

Parameters:

other - the other

Method Detail

getUse

public XBRLVariableResourceUse getUse(XBRLRelationship rel,
                                      XBRLVariablesHolder set)
                               throws XFValidationException

Creates a new XBRLVariableResourceUse instance for this variable resource in the variable resource set.

Parameters:

rel - Relationship that links the set with the variable

set - the XBRLVariableSetResource that contains this variable use

Returns:

new instance of an XBRLVariableResourceUse

Throws:

XFValidationException - in the form of a XFxbrlveVariableNameResolutionFailure

isBindAsSequence

public boolean isBindAsSequence()

Checks if is bind as sequence.

Specified by:

isBindAsSequence in interface XBRLVariableFormulaEvaluable

Returns:

true, if is bind as sequence

getFilters

public java.util.List<XBRLFilterUse> getFilters(Aspect aspect)

Gets the filters.

Specified by:

getFilters in interface XBRLVariableFormulaEvaluable

Parameters:

aspect - the aspect

Returns:

the filters

getKeysAspectsFiltered

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

Gets the keys aspects filtered.

Returns:

the keys aspects filtered

getAllAspectsFiltered

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

Access to all aspects.

Returns:

set of aspects

See Also:

Aspect, Aspects

hasFilterAspect

public boolean hasFilterAspect(Aspect aspectMain,
                               Aspect aspectDimension)

Checks for filter aspect.

Parameters:

aspectMain - the aspect main

aspectDimension - the aspect dimension

Returns:

true, if successful

adjustValueAccordingToType

public net.sf.saxon.s9api.XdmValue adjustValueAccordingToType(net.sf.saxon.s9api.XdmValue val,
                                                              net.sf.saxon.s9api.XdmItem item)
                                                       throws XFValidationException

Checks if the variable has a "as" attribute and: * if it exist; the value in the item parameter is converted to the type indicated * if it does not exist; the value of the val parameter is returned.

Specified by:

adjustValueAccordingToType in interface XBRLVariableFormulaEvaluable

Parameters:

val - value to be returned when no "as" attribute exist on variable

item - the value that must be converted to the type indicated in the as attribute

Returns:

XdmValue (atomic) or the value of the val parameter

Throws:

XFValidationException - the XF validation exception

getVariableType

public XBRLVariableType getVariableType()

Gets the variable type.

Specified by:

getVariableType in interface XBRLVariableFormulaEvaluable

Returns:

the variable type

getExpression

public abstract java.lang.String getExpression()

Used only for debug purposes.

Returns the XPath expression used to evaluate this variable

Returns:

String

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLVariableFormulaEvaluable

Overrides:

clear in class XBRLFormulaResource

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