com.ihr.xbrl.om.instance.autocalculation

Class AutoCalculationProcessor

java.lang.Object

com.ihr.xbrl.om.instance.autocalculation.AutoCalculationProcessor

All Implemented Interfaces:

HasDTSContainer, XBRLPlugInProcessor

public class AutoCalculationProcessor
extends java.lang.Object
implements XBRLPlugInProcessor

The Class AutoCalculationProcessor.

This processor performs no DTS validation but is able to modify the content of an instance document to include new values generated from calculation relationships.

When there is a calculation structure like this A = B + C if there are values in the instance for B (and/or) C, the value of A is calculated

Key methods are: isCalculable(XBRLItem, int) and recalculate(XBRLInstance, int, Set)

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROCESSORNAME The Constant PROCESSORNAME.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
void	configure(java.util.Properties properties) Configure.
static AutoCalculationProcessor	create(DTSContainer dts) Creates the.
int	getCalculationRoleCode(XBRLItem theItem, int possibleCode) Obtains the role code where this concept can be calculated.
DTSContainer	getContainer() Gets the container.
java.lang.String	getDescription() Gets the description.
static java.lang.String	getDescriptionStatic() Gets the description static.
java.lang.String	getName() Gets the name.
boolean	isCalculable(XBRLItem item, int roleCode) Returns true if the item indicated in the item parameter can be calculated using the rules in the calculation linkbase.
boolean	isHidden() Checks if is hidden.
boolean	recalculate(XBRLInstance instance, int roleCode, java.util.Set<PCUEqual> validCUEqualCombinations) Recalculate totals that depends on the factChanged.
static void	registerProcessorStatic() no need to add anything here.
XBRLValidationReport	validate() Validate.
XBRLValidationReport	validate(XBRLDocument xDocument) Validate.

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSORNAME

public static final java.lang.String PROCESSORNAME

The Constant PROCESSORNAME.

See Also:

Constant Field Values

Method Detail

getContainer

public DTSContainer getContainer()

Gets the container.

Specified by:

getContainer in interface HasDTSContainer

Returns:

the container

registerProcessorStatic

public static void registerProcessorStatic()

no need to add anything here.

create

public static AutoCalculationProcessor create(DTSContainer dts)

Creates the.

Parameters:

dts - the dts

Returns:

the auto calculation processor

validate

public XBRLValidationReport validate()

Validate.

Specified by:

validate in interface XBRLPlugInProcessor

Returns:

the XBRL validation report

validate

public XBRLValidationReport validate(XBRLDocument xDocument)

Validate.

Specified by:

validate in interface XBRLPlugInProcessor

Parameters:

xDocument - the x document

Returns:

the XBRL validation report

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface XBRLPlugInProcessor

Returns:

the name

getDescriptionStatic

public static java.lang.String getDescriptionStatic()

Gets the description static.

Returns:

the description static

getDescription

public java.lang.String getDescription()

Gets the description.

Specified by:

getDescription in interface XBRLPlugInProcessor

Returns:

the description

configure

public void configure(java.util.Properties properties)

Configure.

Specified by:

configure in interface XBRLPlugInProcessor

Parameters:

properties - the properties

isHidden

public boolean isHidden()

Checks if is hidden.

Specified by:

isHidden in interface XBRLPlugInProcessor

Returns:

true, if is hidden

clear

public void clear()

Clear.

Specified by:

clear in interface XBRLPlugInProcessor

isCalculable

public boolean isCalculable(XBRLItem item,
                            int roleCode)

Returns true if the item indicated in the item parameter can be calculated using the rules in the calculation linkbase.

This is, when the item is parent of other items using the summation-item calculation networks in the same role

Parameters:

item - the concept definition for which the result will be checked

roleCode - the role code

Returns:

true, if the value can be calculated form other values

recalculate

public boolean recalculate(XBRLInstance instance,
                           int roleCode,
                           java.util.Set<PCUEqual> validCUEqualCombinations)

Recalculate totals that depends on the factChanged. If the factChanged is null, the entire report is calculated.

Parameters:

instance - the instance that contains facts and will be the destination of new facts

roleCode - the role code

validCUEqualCombinations - set of combinations of XBRLContext and XBRLUnit for which calculations will be evaluated. Not all facts in the instance will be used

Returns:

true if the instance has changed

getCalculationRoleCode

public int getCalculationRoleCode(XBRLItem theItem,
                                  int possibleCode)

Obtains the role code where this concept can be calculated.

Parameters:

theItem - item that can be calculated because isCalculable returned true, it might be the role code is different form the role code used in the call to isCalculable

possibleCode - the possible code

Returns:

integer of the role code