com.ihr.xbrl.dts

Interface HasZCombinations

public interface HasZCombinations

Interface to expose methods to query the Combinations of dimensions and values in the Z axis.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
int	getZCombinations(ValidCombinationsFilter vcf) Obtains the number of combinations of values that produce different tables in the X and Y axis depending on values in the Z axis.
boolean	isExcludedZCombination(ValidCombinationsFilter vcf, int zCombNumber) The user can select to exclude a concrete combination.
void	setZCombination(int zCombNumber) Every combination of values in the Z axis is assigned to a sequential number.

Method Detail

getZCombinations

int getZCombinations(ValidCombinationsFilter vcf)

Obtains the number of combinations of values that produce different tables in the X and Y axis depending on values in the Z axis. For instance, if the Period Duration is part of the Z axis and contains two values for two consecutive years and the report contains 2 companies, the number of combinations of values in the Z axis is 4.

Parameters:

vcf - This is an instance of a class that can be asked if a combination is included or excluded by the user

Returns:

the number of different combinations of values in the Z axis

See Also:

setZCombination(int)

setZCombination

void setZCombination(int zCombNumber)

Every combination of values in the Z axis is assigned to a sequential number. During the export operation there is a loop over all possible values in the Z axis and for each combination a number is assigned. This method informs the table about the combination number to be used in the Z axis. When the export operation calls this method with a number from 0 to getZCombinations()-1 the surrounding table model shall be updated to return proper values for x and y that corresponds with this particular combination of values in the Z axis

Parameters:

zCombNumber - the new z combination

See Also:

getZCombinations(ValidCombinationsFilter)

isExcludedZCombination

boolean isExcludedZCombination(ValidCombinationsFilter vcf,
                               int zCombNumber)

The user can select to exclude a concrete combination.

Parameters:

vcf - the vcf

zCombNumber - the z comb number

Returns:

true, if is excluded Z combination