com.batavia.xbrl.taxonomy.dimension
Interface BaseSet


public interface BaseSet

combined relations for ONE extended linkrole and has hypercube (any, all or choice) dimensional arcs (max contributing networks: extrole+any, extrol+all, extrole+choice) for one primary item. Each networkarc (from the PI to HCs) forms a DRS in the baseset The baseset can validate an item by checking wheter its context is valid in all of the basesets' DRS-es with its has hypercube (any, all or choice) relations (one or more) and their DRS-es which inlcude those hypercubes (one or more) based

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:
Ron van Ardenne

Method Summary
 void addBaseSetDRSes(java.util.List DRSes)
           
 void addDRS(DimensionalRelationshipSet DRS)
           
 java.util.Map getAllowedCombinationsDomainMembers(java.lang.String scenarioOrSegment)
          returns map that can be used as model for selecting valid (dim/dom)n combinations for prim items NOTE, allowed or disallowed is per scenario OR per segment
 java.util.List getAllowedDimensions(java.lang.String scenarioOrSegment)
           
 java.util.List getAllowedDimensionsForHypercube(Declaration hypercubeItem)
           
 java.util.List getBaseSetDRSes()
           
 java.lang.String getExtendedLinkRole()
           
 java.util.List getHyperCubeItems()
           
 java.util.List getHyperCubes()
           
 Item getSourcePrimairyItemConcept()
           
 boolean isInherited()
           
 boolean isSummable()
           
 void setExtendedLinkRole(java.lang.String extendedLinkRole)
           
 void setInherited(boolean inherited)
           
 boolean validate(ValidationDocument msgs)
          HCs not combined prim in one has-hc role then prim or descendants may not have other has-hac role 2.5.3.3 If a primary item declaration is the source of a “choice” relationship in a base set, then that primary item, and all of its descendants along the domain-member base set MUST NOT be the source of an “all” relationship in that same base set.
 boolean validateInstance(Context context, Concept primairyItemConcept, ValidationDocument msgs)
           
 boolean validateInstance(Item itemFact, ValidationDocument msgs)
          2.10.2 Determination of the has-hypercube processing order One hypercube related to a primary item that is the parent of the domain-member discoverable relationships set has priority over all it’s descendants in the domain-member discoverable relationships set.
 

Method Detail

getBaseSetDRSes

java.util.List getBaseSetDRSes()
Returns:
Returns the baseSetDRSes.

addBaseSetDRSes

void addBaseSetDRSes(java.util.List DRSes)
Parameters:
DRSes - The baseSetDRSes to set.

addDRS

void addDRS(DimensionalRelationshipSet DRS)
Parameters:
DRSes - The baseSetDRSes to set.

validate

boolean validate(ValidationDocument msgs)
HCs not combined prim in one has-hc role then prim or descendants may not have other has-hac role 2.5.3.3 If a primary item declaration is the source of a “choice” relationship in a base set, then that primary item, and all of its descendants along the domain-member base set MUST NOT be the source of an “all” relationship in that same base set. The validator MUST signal xbrldte:HasHypercubeOperatorInconsistency if this rule is violated. 2.5.3.4 If a primary item declaration is the source of a “choice” relationship in a base set, then that primary item, and all of its descendants along the domain-member base set MUST NOT be the source of an “any” relationship in that same base set. The validator MUST signal xbrldte:HasHypercubeOperatorInconsistency if this rule is violated. 2.8.1.3 An explicit dimension item MUST NOT be the source of more than one dimension-domain relationship in a given base set. A validator MUST signal xbrldte:DimensionDomainMultipleDomains if this rule is violated. 2.4.1.3 A base set MUST NOT contain more than one hypercube-dimension relationship between any pair of hypercube and implicit dimension elements Dimensions MUST be represented by distinct dimension items. A validator MUST ensure that no hypercube has a repeated dimension. Violation of this rule MUST signal xbrldte:RepeatedDimensionInHypercube. Note that this is not guaranteed by XBRL itself which ensures only that there are no repeated arcs within an extended-type link 2.4.1.4 A hypercube MUST NOT be the source of more than one hypercube-dimension relationship with the same value of the order attribute. The dimensions must appear in a total order within a single base set. Violation of this rule must signal xbrldte:AmbiguousDimensionOrderInHypercube.

Returns:

validateInstance

boolean validateInstance(Item itemFact,
                         ValidationDocument msgs)
2.10.2 Determination of the has-hypercube processing order One hypercube related to a primary item that is the parent of the domain-member discoverable relationships set has priority over all it’s descendants in the domain-member discoverable relationships set. The xl:priority attribute is used to set up the priority of arcs in the same level all related to the same element.


validateInstance

boolean validateInstance(Context context,
                         Concept primairyItemConcept,
                         ValidationDocument msgs)

isInherited

boolean isInherited()
Returns:
Returns the inherited.

setInherited

void setInherited(boolean inherited)
Parameters:
inherited - The inherited to set.

getAllowedCombinationsDomainMembers

java.util.Map getAllowedCombinationsDomainMembers(java.lang.String scenarioOrSegment)
returns map that can be used as model for selecting valid (dim/dom)n combinations for prim items NOTE, allowed or disallowed is per scenario OR per segment

Returns:

getAllowedDimensions

java.util.List getAllowedDimensions(java.lang.String scenarioOrSegment)

isSummable

boolean isSummable()

getHyperCubeItems

java.util.List getHyperCubeItems()
Returns:
Returns the hyperCubes.

getHyperCubes

java.util.List getHyperCubes()
Returns:
Returns the hyperCubes.

getExtendedLinkRole

java.lang.String getExtendedLinkRole()
Returns:
Returns the extendedLinkRole.

setExtendedLinkRole

void setExtendedLinkRole(java.lang.String extendedLinkRole)
Parameters:
extendedLinkRole - The extendedLinkRole to set.

getSourcePrimairyItemConcept

Item getSourcePrimairyItemConcept()
Returns:
Returns the sourcePrimairyItemConcept.

getAllowedDimensionsForHypercube

java.util.List getAllowedDimensionsForHypercube(Declaration hypercubeItem)