com.batavia.xbrl.taxonomy.dimension
Interface DimensionalDiscoverableTaxonomySet

All Superinterfaces:

DiscoverableTaxonomySet, java.io.Serializable

public interface DimensionalDiscoverableTaxonomySet
extends DiscoverableTaxonomySet

Dimensional DTS that can discover all components for a dimensional taxonomy on top of the primairy taxonomy components and can create the hypercubes, dimensions, domains, domainmembers, DSR's that may be used to create or validate instance documents regarding the XDT spec extends the standard DTS overrides the discover networks to build the XDT domain overrides the validate instance to validate with the XDT domain overrides the validate to validate the XDT domain adds methods to obatin the XDT components

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

DimensionalMember	createDimensionalMember(FullyQualifiedName dimensionQname, FullyQualifiedName domainMemberQname, ContextElement parent)
void	discoverNetworks() Discover the networks of nodes/concepts that are connected by the arcs in this DTS: check the networks with the cycles allowed attribute on the arcRoleType elements The concepts that are related do not know they are!
java.util.List	findNetworksUsingConceptAsSource(Concept concept, java.lang.String arcLocalName, java.lang.String arcNamespace, java.lang.String arcRole, java.lang.String linkLocalName, java.lang.String linkNamespace, java.lang.String linkRole)
BaseSet	getBaseSet(Item itemConcept, java.lang.String extendedLinkRole) get baseset 1) as declaredBaseSetWithDRS-es for the primaryItem 2) as contributingToBaseSetWithDRS-es for each primary Item descendant that could be found in the DDTS NOTE: contributingDRS-es may only be used (in ordered fashion) when there are no declared DRS-es!
java.util.List	getBaseSets() return all basesets found in this DDTS
java.util.List	getBaseSets(Item itemConcept) returns a list of all basesets(all roles) for this item
Item	getDefaultDomainMemberDeclaration(Declaration dim)
Item	getDefaultDomainMemberDeclaration(ExplicitDimension dim)
Dimension	getDimension(Declaration dimItem, NetworkArc refferingArcHcToDim)
ExplicitDomainMember	getDomainMember(Declaration dmemItem, NetworkArc refferingArc)
java.util.List	getDomainParents(Item domainMember)
DimensionalRelationshipSet	getDRS(NetworkArc arc) when the DRS is not discovered yet create it and it discovers itself
ExplicitDomain	getExplicitDomain(Declaration domItem, NetworkArc refferingArc)
java.util.List	getFullUsableDomainQnamesForExplicitDimension(Declaration dimDecl) get all optional usable domain members that were used in the basesets that use the given dimension.
Hypercube	getHyperCube(Declaration hcItem, NetworkArc refferingArcPrimItemToHc) create per item/role a hc
java.util.List	getLabelledDimensionalDeclarations()
TypedDomain	getTypedDomain(TaxonomyElement domType)
boolean	isExplicitDimension(IdHolder referred)
boolean	isHyperCube(IdHolder referred)
boolean	isImplicitDimension(IdHolder referred)
void	setLabelledDimensionalDeclarations(java.util.List labelledDimensionalDeclarations)
boolean	validate() Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

Methods inherited from interface com.batavia.xbrl.taxonomy.DiscoverableTaxonomySet

addBaseDTS, addLinkbase, addTaxonomySchema, clear, completeInstance, createEmptyInstanceDocument, createPopulatedInstanceDocument, discoverDocument, discoverDocument, discoverDocumentRoot, discoverLinkbase, discoverUrl, findNetworks, findNetworks, findNetworksFromTo, findNetworksUsingConcept, findNetworksUsingConcept, findNetworksUsingConceptWithFilters, findNetworksUsingConceptWithFilters, findNetworksWithFilters, findNetworksWithFilters, findRolesUsingConcept, findRolesUsingConceptWithFilters, findWrapper, getAllDiscoveredNetworks, getArcRoleType, getCalculationMaps, getConcept, getDeclaration, getDiscoveredNetworks, getDtsKey, getDtsMessages, getDtsUrls, getEssenceAliasDefinition, getGeneralSpecialDefinition, getGroup, getIdHolder, getIndicators, getKnownArcroleTypes, getKnownAttributeGroups, getKnownAttributes, getKnownConcepts, getKnownConceptsInTupleConceptsQnames, getKnownDeclarations, getKnownGroups, getKnownItemTupleConcepts, getKnownRoleTypes, getKnownTypes, getKnownXbrlTypes, getLabels, getLinkBase, getLinkbases, getMainTaxonomySchema, getNetworkBaseSets, getNetworks, getOrderedRoles, getReferences, getRequiresElementDefinition, getRoleType, getSimilarTuplesDefinition, getSubstitutions, getSubstitutions, getSupportedLanguageCodes, getTaxonomySchemas, getTuplesWithRefTo, getType, getXSDatatypeByName, getXSDatatypes, getXSDatatypesToConceptTypes, isValid, isXbrlInstanceSchemaImported, putXSDatatypeByName, removeLinkbase, removeTaxonomySchema, setDtsKey, setKnownConceptsInTupleConcepts, setMainTaxonomySchema, setValid, setXbrlInstanceSchemaImported, setXSDatatypes, setXSDatatypesToConceptTypes, validateInstance

Method Detail

discoverNetworks

void discoverNetworks()

Description copied from interface: DiscoverableTaxonomySet

Discover the networks of nodes/concepts that are connected by the arcs in this DTS: check the networks with the cycles allowed attribute on the arcRoleType elements The concepts that are related do not know they are! If the networks are valid, create them, else throw exception

Specified by:

discoverNetworks in interface DiscoverableTaxonomySet

isExplicitDimension

boolean isExplicitDimension(IdHolder referred)

isHyperCube

boolean isHyperCube(IdHolder referred)

isImplicitDimension

boolean isImplicitDimension(IdHolder referred)

validate

boolean validate()

Description copied from interface: DiscoverableTaxonomySet

Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

Specified by:

validate in interface DiscoverableTaxonomySet

Returns:

true if there ar no problems with this XbrlElementImpl

getDRS

DimensionalRelationshipSet getDRS(NetworkArc arc)

when the DRS is not discovered yet create it and it discovers itself

Parameters:

arc -

Returns:

getBaseSets

java.util.List getBaseSets(Item itemConcept)

returns a list of all basesets(all roles) for this item

Parameters:

itemConcept -

Returns:

getBaseSet

BaseSet getBaseSet(Item itemConcept,
                   java.lang.String extendedLinkRole)

get baseset 1) as declaredBaseSetWithDRS-es for the primaryItem 2) as contributingToBaseSetWithDRS-es for each primary Item descendant that could be found in the DDTS NOTE: contributingDRS-es may only be used (in ordered fashion) when there are no declared DRS-es!

Parameters:

itemConcept -

Returns:

getDomainParents

java.util.List getDomainParents(Item domainMember)

Parameters:

instance -

Returns:

getHyperCube

Hypercube getHyperCube(Declaration hcItem,
                       NetworkArc refferingArcPrimItemToHc)

create per item/role a hc

Parameters:

hcItem -

targetRole -

Returns:

getDimension

Dimension getDimension(Declaration dimItem,
                       NetworkArc refferingArcHcToDim)

getDefaultDomainMemberDeclaration

Item getDefaultDomainMemberDeclaration(ExplicitDimension dim)

getDefaultDomainMemberDeclaration

Item getDefaultDomainMemberDeclaration(Declaration dim)

getExplicitDomain

ExplicitDomain getExplicitDomain(Declaration domItem,
                                 NetworkArc refferingArc)

getTypedDomain

TypedDomain getTypedDomain(TaxonomyElement domType)

getDomainMember

ExplicitDomainMember getDomainMember(Declaration dmemItem,
                                     NetworkArc refferingArc)

findNetworksUsingConceptAsSource

java.util.List findNetworksUsingConceptAsSource(Concept concept,
                                                java.lang.String arcLocalName,
                                                java.lang.String arcNamespace,
                                                java.lang.String arcRole,
                                                java.lang.String linkLocalName,
                                                java.lang.String linkNamespace,
                                                java.lang.String linkRole)

createDimensionalMember

DimensionalMember createDimensionalMember(FullyQualifiedName dimensionQname,
                                          FullyQualifiedName domainMemberQname,
                                          ContextElement parent)

getLabelledDimensionalDeclarations

java.util.List getLabelledDimensionalDeclarations()

Returns:

Returns the labelledDimensionalDeclarations.

setLabelledDimensionalDeclarations

void setLabelledDimensionalDeclarations(java.util.List labelledDimensionalDeclarations)

Parameters:

labelledDimensionalDeclarations - The labelledDimensionalDeclarations to set.

getBaseSets

java.util.List getBaseSets()

return all basesets found in this DDTS

Returns:

getFullUsableDomainQnamesForExplicitDimension

java.util.List getFullUsableDomainQnamesForExplicitDimension(Declaration dimDecl)

get all optional usable domain members that were used in the basesets that use the given dimension.

Parameters:

dimDecl -

Returns: