com.ihr.xbrl.dts

Class ValidCombinationsFilter

java.lang.Object

com.ihr.xbrl.dts.ValidCombinationsFilter

public class ValidCombinationsFilter
extends java.lang.Object

This class will maintain information about excluded combinations by user for elements in all axis that will produce or not a new form during the excel generation process. A GUI can add entries to this class in the form of combinations permitted or not permitted. The generation process will ask this class if the combination is granted before the table is generated

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidCombinationsFilter.DimMemberCombination Class to store the combinations of member/dimension of axis of a XBRLTableLayout.
static class	ValidCombinationsFilter.PeriodCombination This is a pair of ColumnPeriod instances, one duration and one instant.

Constructor Summary

Constructors

Constructor and Description
ValidCombinationsFilter() Instantiates a new valid combinations filter.

Method Summary

Modifier and Type	Method and Description
void	addExcludedDimMember(XBRLRoleType role, int viewModeCode, java.lang.String itemCode, int axis, java.lang.String dim, java.lang.String mem) Adds a excluded combination dimension/member/axis.
void	addExcludedPeriod(ValidCombinationsFilter.PeriodCombination epc, XBRLRoleType role, int viewModeCode, java.lang.String itemCode) Adds a new rule for a new excluded period combination.
boolean	isExcludedDimMember(XBRLRoleType role, int viewModeCode, java.lang.String itemCode, int axis, java.lang.String dim, java.lang.String mem) Return true if the dimension/member/axis combination is excluded.
boolean	isExcludedDimMemberCellHeader(XBRLRoleType role, int viewModeCode, java.lang.String itemCode, int axis, CellHeader ch) Checks if is excluded dim member cell header.
boolean	isExcludedPeriod(ColumnPeriod memInstant, ColumnPeriod memDuration, XBRLRoleType role, int viewModeCode, java.lang.String itemCode) This method compares a combination of duration and instant and returns true or false depending on the rules.
boolean	isExcludedPeriod(java.util.List<Member<?>> lst, XBRLRoleType role, int viewModeCode, java.lang.String itemCode) This is the method that compares a combination received against the stored rules and returns true or false depending on the rules result.
static void	migratePropertyToDatabase(java.lang.String sKey, java.lang.String propValue) Migrate property to database.
java.util.Set<ValidCombinationsFilter.PeriodCombination>	prepareExcludedPeriods(java.util.Set<ColumnPeriod> allInstantPeriods, java.util.Set<ColumnPeriod> allDurationPeriods, XBRLRoleType role, int viewModeCode, java.lang.String itemCode) Prepares a set of excluded period combinations from the incoming sets of instants and durations.
void	removeAllExcludedDimMembers(XBRLRoleType role, int viewModeCode, java.lang.String itemCode, int axis) Removes all excluded combinations of dimension/member/axis.
void	removeAllExcludedPeriods(XBRLRoleType role, int viewModeCode, java.lang.String itemCode) Removes all excluded period combinations stored for the role and viewModeCode in the application properties set in the props parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidCombinationsFilter

public ValidCombinationsFilter()

Instantiates a new valid combinations filter.

Method Detail

isExcludedPeriod

public boolean isExcludedPeriod(java.util.List<Member<?>> lst,
                                XBRLRoleType role,
                                int viewModeCode,
                                java.lang.String itemCode)

This is the method that compares a combination received against the stored rules and returns true or false depending on the rules result.

Parameters:

lst - LinkedList of members. PeriodMembers will be explored inside

role - the XBRLRoleType that will be examined, each role type might have different roles

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

Returns:

true if the combination derived from members in lst is excluded against stored rules

isExcludedPeriod

public boolean isExcludedPeriod(ColumnPeriod memInstant,
                                ColumnPeriod memDuration,
                                XBRLRoleType role,
                                int viewModeCode,
                                java.lang.String itemCode)

This method compares a combination of duration and instant and returns true or false depending on the rules. A combination can be:

• instant == null and duration != null, combination validity is user defined
• instant != null and duration == null, combination validity is user defined
• instant != null and duration != null,

Parameters:

memInstant - ColumnPeriod with instant may be null if memDuration is not null

memDuration - ColumnPeriod with duration may be null y memInstant is not null

role - the XBRLRoleType that will be examined, each role type might have different roles

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

Returns:

true if the combination derived from members in lst is valid against stored rules

addExcludedPeriod

public void addExcludedPeriod(ValidCombinationsFilter.PeriodCombination epc,
                              XBRLRoleType role,
                              int viewModeCode,
                              java.lang.String itemCode)

Adds a new rule for a new excluded period combination.

Parameters:

epc - the valid combination to add

role - the role for the valid combination

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

removeAllExcludedPeriods

public void removeAllExcludedPeriods(XBRLRoleType role,
                                     int viewModeCode,
                                     java.lang.String itemCode)

Removes all excluded period combinations stored for the role and viewModeCode in the application properties set in the props parameter. Moved to the ValidCombinationsDatabase class on the GUI project

Parameters:

role - the role

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

prepareExcludedPeriods

public java.util.Set<ValidCombinationsFilter.PeriodCombination> prepareExcludedPeriods(java.util.Set<ColumnPeriod> allInstantPeriods,
                                                                                       java.util.Set<ColumnPeriod> allDurationPeriods,
                                                                                       XBRLRoleType role,
                                                                                       int viewModeCode,
                                                                                       java.lang.String itemCode)

Prepares a set of excluded period combinations from the incoming sets of instants and durations. All possible combinations are matched against already stored rules

Parameters:

allInstantPeriods - the all instant periods

allDurationPeriods - the all duration periods

role - the role

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

Returns:

a set of valid combinations using existing rules

migratePropertyToDatabase

public static void migratePropertyToDatabase(java.lang.String sKey,
                                             java.lang.String propValue)

Migrate property to database.

Parameters:

sKey - the s key

propValue - the prop value

addExcludedDimMember

public void addExcludedDimMember(XBRLRoleType role,
                                 int viewModeCode,
                                 java.lang.String itemCode,
                                 int axis,
                                 java.lang.String dim,
                                 java.lang.String mem)

Adds a excluded combination dimension/member/axis.

Parameters:

role - the role

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

axis - the integer axis code

dim - the Dimension

mem - the Member of the Dimension

removeAllExcludedDimMembers

public void removeAllExcludedDimMembers(XBRLRoleType role,
                                        int viewModeCode,
                                        java.lang.String itemCode,
                                        int axis)

Removes all excluded combinations of dimension/member/axis.

Parameters:

role - the role

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

axis - the integer axis code

isExcludedDimMember

public boolean isExcludedDimMember(XBRLRoleType role,
                                   int viewModeCode,
                                   java.lang.String itemCode,
                                   int axis,
                                   java.lang.String dim,
                                   java.lang.String mem)

Return true if the dimension/member/axis combination is excluded.

Parameters:

role - the role

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

axis - the integer axis code

dim - the Dimension

mem - the Member of the Dimension

Returns:

true if the dimension/member/axis is excluded

isExcludedDimMemberCellHeader

public boolean isExcludedDimMemberCellHeader(XBRLRoleType role,
                                             int viewModeCode,
                                             java.lang.String itemCode,
                                             int axis,
                                             CellHeader ch)

Checks if is excluded dim member cell header.

Parameters:

role - the role

viewModeCode - a number to deal with several uses of the same role

itemCode - the item code

axis - the integer axis code

ch - the axis CellHeader

Returns:

true if the CellHeader is excluded