com.ihr.xbrl.om.formula.aspects.tests

Class XFDimensionsTestController

java.lang.Object

com.ihr.xbrl.om.formula.aspects.tests.XFDimensionsTestController

All Implemented Interfaces:

XFAspectTestInterface

public class XFDimensionsTestController
extends java.lang.Object
implements XFAspectTestInterface

The Class XFDimensionsTestController.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XFDimensionsTestController(XBRLFormulaProcessor formulaProcessor, XMLFragment res) Instantiates a new XF dimensions test controller.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	bResultsCacheable() Returns true if the results can be obtained from the aspects cache or can be sent to the aspects cache after evaluation.
boolean	equivaletValues(net.sf.saxon.s9api.XdmValue fact1, net.sf.saxon.s9api.XdmValue fact2) Two facts have equivalent values for a given aspect if the aspect test for that aspect evaluates to true.
java.util.HashSet<com.ihr.xbrl.om.formula.aspects.tests.XFDimensionsTestController.CacheKeyDimensionAndValue>	getCacheVal1() In case bResultsCacheable returns true, this must return the Object that will be stored into the cache for the first variable to test aspects from.
java.util.HashSet<com.ihr.xbrl.om.formula.aspects.tests.XFDimensionsTestController.CacheKeyDimensionAndValue>	getCacheVal2() In case bResultsCacheable returns true, this must return the Object that will be stored into the cache for the second variable to test aspects from.
void	setDimensionsToTest(java.util.Collection<javax.xml.namespace.QName> dimensionsToTestA) Call this method in order to set the set of dimensions to tests between two variables.
void	setDimensionsToTest(net.sf.saxon.s9api.XdmNode fact1, net.sf.saxon.s9api.XdmNode fact2) Sets the dimensions to test.

Methods inherited from class java.lang.Object

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

Constructor Detail

XFDimensionsTestController

public XFDimensionsTestController(XBRLFormulaProcessor formulaProcessor,
                          XMLFragment res)

Instantiates a new XF dimensions test controller.

Parameters:

formulaProcessor - the formula processor

res - the resource that will be used for namespace context and resolution of xml:base

Method Detail

equivaletValues

public boolean equivaletValues(net.sf.saxon.s9api.XdmValue fact1,
                      net.sf.saxon.s9api.XdmValue fact2)
                        throws XFValidationException

Description copied from interface: XFAspectTestInterface

Two facts have equivalent values for a given aspect if the aspect test for that aspect evaluates to true.

This interface MUST be implemented by classes dealing with different aspects

Specified by:

equivaletValues in interface XFAspectTestInterface

Parameters:

fact1 - This one of the facts to compare

fact2 - This is the fact to compare to

Returns:

true, if successful

Throws:

XFValidationException - in case of errors in the XPath expression definitions (custom attribute in the typed dimensions and multiple typed dimensions defined)

setDimensionsToTest

public void setDimensionsToTest(java.util.Collection<javax.xml.namespace.QName> dimensionsToTestA)

Call this method in order to set the set of dimensions to tests between two variables.

Parameters:

dimensionsToTestA - the new dimensions to test

setDimensionsToTest

public void setDimensionsToTest(net.sf.saxon.s9api.XdmNode fact1,
                       net.sf.saxon.s9api.XdmNode fact2)

Sets the dimensions to test.

Parameters:

fact1 - the fact1

fact2 - the fact2

bResultsCacheable

public boolean bResultsCacheable()

Description copied from interface: XFAspectTestInterface

Returns true if the results can be obtained from the aspects cache or can be sent to the aspects cache after evaluation.

Specified by:

bResultsCacheable in interface XFAspectTestInterface

Returns:

boolean

getCacheVal1

public java.util.HashSet<com.ihr.xbrl.om.formula.aspects.tests.XFDimensionsTestController.CacheKeyDimensionAndValue> getCacheVal1()

Description copied from interface: XFAspectTestInterface

In case bResultsCacheable returns true, this must return the Object that will be stored into the cache for the first variable to test aspects from.

Specified by:

getCacheVal1 in interface XFAspectTestInterface

Returns:

Object

getCacheVal2

public java.util.HashSet<com.ihr.xbrl.om.formula.aspects.tests.XFDimensionsTestController.CacheKeyDimensionAndValue> getCacheVal2()

Description copied from interface: XFAspectTestInterface

In case bResultsCacheable returns true, this must return the Object that will be stored into the cache for the second variable to test aspects from.

Specified by:

getCacheVal2 in interface XFAspectTestInterface

Returns:

Object