com.ihr.xbrl.om.formula.util

Class XBRLVariableTree

java.lang.Object

com.ihr.xbrl.om.formula.util.XBRLVariableTree

public class XBRLVariableTree
extends java.lang.Object

The Class XBRLVariableTree.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log The log.

Constructor Summary

Constructors

Constructor and Description
XBRLVariableTree(XBRLVariableSetResource set) Instantiates a new XBRL variable tree.

Method Summary

Modifier and Type	Method and Description
boolean	bindCycle(XMLEvaluationContextProvider evalProvider, java.util.List<XBRLVariableResourceUse> evaluatedVars) Bind variables in this level.
void	clear() Reset all memory assigned to evaluation caches of variables in this variable tree.
java.util.Set<javax.xml.namespace.QName>	getDependants(javax.xml.namespace.QName thisVarName) Obtains a set of variables that depends down on the evaluation of this variable.
VariablesLoopController.ClsVariableSetCombinationsIterator	getImplicitFilterController(XBRLVariableSetResource xbrlVariableSetResource) Gets the implicit filter controller.
java.util.Set<javax.xml.namespace.QName>	getRequired(javax.xml.namespace.QName thisVarName) Obtain variable dependencies of thisVarName.
com.ihr.xbrl.om.formula.util.VariableType	getVariableDependencyType(javax.xml.namespace.QName qName) Gets the variable dependency type.
boolean	hasActiveSubPartitioning() Checks for active sub partitioning.
boolean	hasNext() Checks for next.
boolean	initialize(XMLEvaluationContextProvider evalProvider, java.util.List<XBRLVariableResourceUse> evaluatedVars) Initialize the tree and returns true if there is at least one binding or false if there are no bindings.
boolean	isLastVarWithDependency(javax.xml.namespace.QName var, javax.xml.namespace.QName dependent) Returns true if there are no other variable with a dependency of dependent variable that will be evaluated after var.
void	reset() Reset all memory assigned to evaluation caches of variables in this variable tree.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

The log.

Constructor Detail

XBRLVariableTree

public XBRLVariableTree(XBRLVariableSetResource set)
                 throws XFValidationException

Instantiates a new XBRL variable tree.

Parameters:

set - the variable set

Throws:

XFValidationException - the XF validation exception

Method Detail

bindCycle

public boolean bindCycle(XMLEvaluationContextProvider evalProvider,
                         java.util.List<XBRLVariableResourceUse> evaluatedVars)
                  throws XFValidationException

Bind variables in this level. Then, call next level. This object acts as variable resolver for variables already resolved

Parameters:

evalProvider - the eval provider

evaluatedVars - the evaluated vars

Returns:

boolean true if binding is OK because not all variables bind to fall back values

Throws:

XFValidationException - the XF validation exception

hasNext

public boolean hasNext()

Checks for next.

Returns:

true, if successful

hasActiveSubPartitioning

public boolean hasActiveSubPartitioning()

Checks for active sub partitioning.

Returns:

true, if successful

getImplicitFilterController

public VariablesLoopController.ClsVariableSetCombinationsIterator getImplicitFilterController(XBRLVariableSetResource xbrlVariableSetResource)

Gets the implicit filter controller.

Parameters:

xbrlVariableSetResource - the xbrl variable set resource

Returns:

the implicit filter controller

getDependants

public java.util.Set<javax.xml.namespace.QName> getDependants(javax.xml.namespace.QName thisVarName)

Obtains a set of variables that depends down on the evaluation of this variable.

Parameters:

thisVarName - the variable name for which dependent variables will be obtained

Returns:

the set of dependent variables of thisVarName

getVariableDependencyType

public com.ihr.xbrl.om.formula.util.VariableType getVariableDependencyType(javax.xml.namespace.QName qName)

Gets the variable dependency type.

Parameters:

qName - the q name

Returns:

the variable dependency type

initialize

public boolean initialize(XMLEvaluationContextProvider evalProvider,
                          java.util.List<XBRLVariableResourceUse> evaluatedVars)
                   throws XFValidationException

Initialize the tree and returns true if there is at least one binding or false if there are no bindings.

Parameters:

evalProvider - the eval provider

evaluatedVars - the evaluated vars

Returns:

boolean

Throws:

XFValidationException - the XF validation exception

reset

public void reset()

Reset all memory assigned to evaluation caches of variables in this variable tree.

clear

public void clear()

Reset all memory assigned to evaluation caches of variables in this variable tree.

isLastVarWithDependency

public boolean isLastVarWithDependency(javax.xml.namespace.QName var,
                                       javax.xml.namespace.QName dependent)

Returns true if there are no other variable with a dependency of dependent variable that will be evaluated after var.

Parameters:

var - the var

dependent - the dependent

Returns:

true if var is the last variable with a dependency of dependent

getRequired

public java.util.Set<javax.xml.namespace.QName> getRequired(javax.xml.namespace.QName thisVarName)

Obtain variable dependencies of thisVarName.

Parameters:

thisVarName - is the variable that cannot be evaluated without values bind to the dependent variables

Returns:

a set of variable names thisVarName depends on