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

Class XFDimensionsAspectTest

java.lang.Object

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

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

All Implemented Interfaces:

XFAspectTestInterface

Direct Known Subclasses:

XFExplicitDimensionAspectTest, XFTypedDimensionAspectTest

public abstract class XFDimensionsAspectTest
extends XFAspectTestAbstract

The Class XFDimensionsAspectTest.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XFDimensionsAspectTest(XBRLFormulaProcessor fp, XMLFragment fragment, java.lang.String expression, net.sf.saxon.s9api.QName varName, net.sf.saxon.s9api.QName varValue) Instantiates a new XF dimensions aspect test.

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.
int	getAspect() Access to the constant defined in the CommonAspectRule class indicating the aspect this instance works with.
XMLFragment	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.
XMLFragment	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.

Methods inherited from class com.ihr.xbrl.om.formula.aspects.tests.XFAspectTestAbstract

equivaletValues

Methods inherited from class java.lang.Object

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

Constructor Detail

XFDimensionsAspectTest

public XFDimensionsAspectTest(XBRLFormulaProcessor fp,
                      XMLFragment fragment,
                      java.lang.String expression,
                      net.sf.saxon.s9api.QName varName,
                      net.sf.saxon.s9api.QName varValue)

Instantiates a new XF dimensions aspect test.

Parameters:

fp - the fp

fragment - the fragment

expression - the expression

varName - the var name

varValue - the var value

Method Detail

getAspect

public int getAspect()

Description copied from class: XFAspectTestAbstract

Access to the constant defined in the CommonAspectRule class indicating the aspect this instance works with. Aspects are bitmapped

Specified by:

getAspect in class XFAspectTestAbstract

Returns:

integer constant

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.

Returns:

boolean

getCacheVal1

public XMLFragment 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.

Returns:

Object

getCacheVal2

public XMLFragment 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.

Returns:

Object