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

All Known Implementing Classes:

XFAspectTestAbstract, XFCompleteScenarioAspectTest, XFCompleteSegmentAspectTest, XFConceptAspectTest, XFDimensionsAspectTest, XFDimensionsTestController, XFEntityAspectTest, XFExplicitDimensionAspectTest, XFLocationAspectTest, XFNonXDTScenarioAspectTest, XFNonXDTSegmentAspectTest, XFPeriodAspectTest, XFTypedDimensionAspectTest, XFUnitAspectTest

public interface XFAspectTestInterface

Author:

Ignacio

Method Summary

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.
XMLFragment	getCacheVal1() In case bResultsCacheable returns true, this must return the XML fragment that will be stored into the cache for the first variable to test aspects from
XMLFragment	getCacheVal2() In case bResultsCacheable returns true, this must return the XML fragment that will be stored into the cache for the second variable to test aspects from

Method Detail

equivaletValues

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

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

Parameters:

fact1 - This one of the facts to compare

fact2 - This is the fact to compare to

Returns:

Throws:

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

bResultsCacheable

boolean bResultsCacheable()

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

Returns:

boolean

getCacheVal1

XMLFragment getCacheVal1()

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

Returns:

XMLFragment

getCacheVal2

XMLFragment getCacheVal2()

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

Returns:

XMLFragment