com.ihr.xbrl.om.formula.util
Class VariablesLoopController

java.lang.Object
  com.ihr.xbrl.om.formula.util.VariablesLoopController

public class VariablesLoopController
extends java.lang.Object

This class is a controller for iterators over all binded variables for a formula.

Author:

Ignacio

Nested Class Summary

static class	VariablesLoopController.ClsVariableSetCombinationsIterator
static class	VariablesLoopController.ClsVariableSetCombinationsIterator2

Constructor Summary

VariablesLoopController()

Method Summary

ClsVarIterator	createIterator(javax.xml.namespace.QName varName)
VariablesLoopController.ClsVariableSetCombinationsIterator	getImplicitFilterController(XBRLVariableSetResource xbrlVariableSetResource)
int	getLevel()
boolean	hasActiveSubPartitioning()
boolean	hasNext()
boolean	hasNext(javax.xml.namespace.QName variableName)
void	initialize(XBRLVariableTree tree, XMLEvaluationContextProvider evalProvider, java.util.Vector<XBRLVariableResourceUse> evaluatedVars) Initializes the VariablesLoopController by setting the value of the tree that contains the variables required for each evaluation level and the interdependencies between variables.
boolean	isFallbackValue(javax.xml.namespace.QName variableName)
boolean	isValidInitialBinding()
void	next()
net.sf.saxon.s9api.XdmValue	next(javax.xml.namespace.QName variableName, XBRLVariableResource res) This returns the next element in the sequence or the last returned element in the sequence if the sequence is not the topmost sequence in the stack.
boolean	uninitialized()

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablesLoopController

public VariablesLoopController()

Method Detail

hasNext

public boolean hasNext(javax.xml.namespace.QName variableName)
                throws XFValidationException

Throws:

XFValidationException

next

public net.sf.saxon.s9api.XdmValue next(javax.xml.namespace.QName variableName,
                                        XBRLVariableResource res)
                                 throws XFValidationException

This returns the next element in the sequence or the last returned element in the sequence if the sequence is not the topmost sequence in the stack.

Parameters:

variableName -

Returns:

Throws:

XFValidationException

getImplicitFilterController

public VariablesLoopController.ClsVariableSetCombinationsIterator getImplicitFilterController(XBRLVariableSetResource xbrlVariableSetResource)

Parameters:

xbrlVariableSetResource -

hasActiveSubPartitioning

public boolean hasActiveSubPartitioning()

Returns:

isFallbackValue

public boolean isFallbackValue(javax.xml.namespace.QName variableName)
                        throws XFValidationException

Parameters:

variableName -

Returns:

Throws:

XFValidationException

uninitialized

public boolean uninitialized()

Returns:

createIterator

public ClsVarIterator createIterator(javax.xml.namespace.QName varName)

getLevel

public int getLevel()

initialize

public void initialize(XBRLVariableTree tree,
                       XMLEvaluationContextProvider evalProvider,
                       java.util.Vector<XBRLVariableResourceUse> evaluatedVars)
                throws XFValidationException

Initializes the VariablesLoopController by setting the value of the tree that contains the variables required for each evaluation level and the interdependencies between variables.

Then, create an iterator that can be used for iterating throw all variables

Then move to the first value in the loop.

Then, initialization is finished.

A call to next() will return the calculated value and move forward to the next element and so on.

Parameters:

evaluatedVars -

evalProvider -

xbrlVariableTree -

Throws:

XFValidationException

hasNext

public boolean hasNext()

Returns:

next

public void next()
          throws XFValidationException

Parameters:

b -

Throws:

XFValidationException

isValidInitialBinding

public boolean isValidInitialBinding()

Returns: