com.ihr.xbrl.om.formula

Interface XBRLVariableFormulaEvaluable

All Known Implementing Classes:

XBRLVariableFact, XBRLVariableGeneral, XBRLVariableInternal, XBRLVariableParameter, XBRLVariableResource

public interface XBRLVariableFormulaEvaluable

The Interface XBRLVariableFormulaEvaluable.

Author:

Ignacio

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.
boolean	checkVariable(XBRLVariablesHolder set, javax.xml.namespace.QName name, java.util.Collection<net.sf.saxon.s9api.QName> resolved) Called for variables that are also resources during the static compilation phase of the formula preparation.
void	clear() Used to clean up.
Evaluation	evaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars, XBRLVariableSetResource set) Evaluates the resource internal XPath expression and returns either the returned value from the XPath expression or the fall back value in the case of variables that may have a fall back value and the rawEvaluation of the XPath expression results in the empty sequence.
java.util.List<XBRLFilterUse>	getFilters(Aspect aspect) Gets the filters.
XBRLFormulaProcessor	getProcessor() Returns an instance of the XBRLFormulaProcessor this variable has been created under
java.util.Collection<javax.xml.namespace.QName>	getVariablesRequired(XBRLVariablesHolder set) Returns a collection of variables required for the evaluation of this variable.
XBRLVariableType	getVariableType() Gets the variable type.
XMLFragment	getXMLFragment() Returns the surrounding XML Fragment this resource comes from.
boolean	isBindAsSequence() In the case of resource based variables this reads the surrounding syntax and returns the value of the bindAsSequence.
Evaluation	rawEvaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars) Evaluates the resource internal XPath expression and returns the sequence.
void	reset() Used to reset evaluation caches.

Method Detail

evaluateValue

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

Evaluates the resource internal XPath expression and returns either the returned value from the XPath expression or the fall back value in the case of variables that may have a fall back value and the rawEvaluation of the XPath expression results in the empty sequence. The raw evaluation of the XPath expression is implemented in the rawEvaluateValue(XMLFragment, Collection) call.

Parameters:

evaluationContext - the evaluation context

availableVars - the available vars

set - the set

Returns:

the evaluation

Throws:

XFValidationException - the XF validation exception

See Also:

rawEvaluateValue(XMLFragment, Collection)

rawEvaluateValue

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

Evaluates the resource internal XPath expression and returns the sequence. This method does not considers nor evaluates the default value if any is possible. The evaluation considering default values is implemented in the evaluateValue(XMLFragment, Collection, XBRLVariableSetResource) method.

Parameters:

evaluationContext - the evaluation context

availableVars - the available vars

Returns:

the evaluation

Throws:

XFValidationException - the XF validation exception

isBindAsSequence

boolean isBindAsSequence()

In the case of resource based variables this reads the surrounding syntax and returns the value of the bindAsSequence.

In other cases relays on the implementation

Returns:

true, if successful

checkVariable

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

Called for variables that are also resources during the static compilation phase of the formula preparation.

throws exceptions according to the validation rules.

shall return true on success

Parameters:

set - the set

name - the name

resolved - the resolved

Returns:

true, if successful

Throws:

XFValidationException - the XF validation exception

getVariablesRequired

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

Returns a collection of variables required for the evaluation of this variable.

Parameters:

set - the variable for which the required variables will be obtained

Returns:

collection of QNames. The variable order should be consistent so the processor produce the same results on each evaluation.

getProcessor

XBRLFormulaProcessor getProcessor()

Returns an instance of the XBRLFormulaProcessor this variable has been created under

Returns:

XBRLFormulaProcessor

getFilters

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

Gets the filters.

Parameters:

aspect - the aspect

Returns:

the filters

getVariableType

XBRLVariableType getVariableType()

Gets the variable type.

Returns:

the variable type

adjustValueAccordingToType

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.

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

clear

void clear()
    throws java.lang.Throwable

Used to clean up.

Throws:

java.lang.Throwable - the throwable

getXMLFragment

XMLFragment getXMLFragment()

Returns the surrounding XML Fragment this resource comes from.

Returns:

the XML fragment

reset

void reset()
    throws java.lang.Throwable

Used to reset evaluation caches.

Throws:

java.lang.Throwable - the throwable