com.ihr.xbrl.om.formula

Class XBRLVariableInternal

java.lang.Object

com.ihr.xbrl.om.formula.XBRLVariableInternal

All Implemented Interfaces:

XBRLVariableFormulaEvaluable

public class XBRLVariableInternal
extends java.lang.Object
implements XBRLVariableFormulaEvaluable

This allows for creating a XBRLVariableResourceUse derived from something the extension of the formula processor can use.

This class implements the XBRLVariableFormulaEvaluable interface

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XBRLVariableInternal(XBRLFormulaProcessor proc, net.sf.saxon.s9api.XdmValue value) Instantiates a new XBRL variable internal.
XBRLVariableInternal(XBRLFormulaProcessor proc, net.sf.saxon.s9api.XdmValue value, boolean bindAsSequence) Instantiates a new XBRL variable internal.

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) Adjust value according to type.
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.
java.util.List<XBRLFilterUse>	getFilters(Aspect aspect) Gets the filters.
XBRLFormulaProcessor	getProcessor() Gets the processor.
java.util.Collection<javax.xml.namespace.QName>	getVariablesRequired(XBRLVariablesHolder set) Gets the variables required.
XBRLVariableType	getVariableType() Gets the variable type.
XMLFragment	getXMLFragment() Gets the XML fragment.
boolean	isBindAsSequence() Checks if is bind as sequence.
Evaluation	rawEvaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars) Raw evaluate value.
void	reset() Reset.

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLVariableInternal

public XBRLVariableInternal(XBRLFormulaProcessor proc,
                            net.sf.saxon.s9api.XdmValue value)

Instantiates a new XBRL variable internal.

Parameters:

proc - the proc

value - the value

XBRLVariableInternal

public XBRLVariableInternal(XBRLFormulaProcessor proc,
                            net.sf.saxon.s9api.XdmValue value,
                            boolean bindAsSequence)

Instantiates a new XBRL variable internal.

Parameters:

proc - the proc

value - the value

bindAsSequence - the bind as sequence

Method Detail

evaluateValue

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

Evaluate value.

Specified by:

evaluateValue in interface XBRLVariableFormulaEvaluable

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)

rawEvaluateValue

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

Raw evaluate value.

Specified by:

rawEvaluateValue in interface XBRLVariableFormulaEvaluable

Parameters:

evaluationContext - the evaluation context

availableVars - the available vars

Returns:

the evaluation

Throws:

XFValidationException - the XF validation exception

clear

public void clear()

Clear.

Specified by:

clear in interface XBRLVariableFormulaEvaluable

isBindAsSequence

public boolean isBindAsSequence()

Checks if is bind as sequence.

Specified by:

isBindAsSequence in interface XBRLVariableFormulaEvaluable

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.

Specified by:

checkVariable in interface XBRLVariableFormulaEvaluable

Parameters:

set - the set

name - the name

resolved - the resolved

Returns:

true, if successful

Throws:

XFValidationException - the XF validation exception

getVariablesRequired

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

Gets the variables required.

Specified by:

getVariablesRequired in interface XBRLVariableFormulaEvaluable

Parameters:

set - the set

Returns:

the variables required

getProcessor

public XBRLFormulaProcessor getProcessor()

Gets the processor.

Specified by:

getProcessor in interface XBRLVariableFormulaEvaluable

Returns:

the processor

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

getVariableType

public XBRLVariableType getVariableType()

Gets the variable type.

Specified by:

getVariableType in interface XBRLVariableFormulaEvaluable

Returns:

the variable type

adjustValueAccordingToType

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

Adjust value according to type.

Specified by:

adjustValueAccordingToType in interface XBRLVariableFormulaEvaluable

Parameters:

val - the val

item - the item

Returns:

the xdm value

Throws:

XFValidationException - the XF validation exception

getXMLFragment

public XMLFragment getXMLFragment()

Gets the XML fragment.

Specified by:

getXMLFragment in interface XBRLVariableFormulaEvaluable

Returns:

the XML fragment

reset

public void reset()

Reset.

Specified by:

reset in interface XBRLVariableFormulaEvaluable