com.batavia.xbrl.taxonomy.dimension
Interface DimensionalTaxonomyCreator

All Superinterfaces:

TaxonomyCreator

All Known Subinterfaces:

DimensionalTaxonomyGenerator

public interface DimensionalTaxonomyCreator
extends TaxonomyCreator

TaxonomyCreator interface for creating dimensional taxonomy content with convenience methods for hypercubes, dimensions, domains, domainmembers, etc. Strict control over document content.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	createDefaultDomainMemberRelation(Item dimensionItem, Item domainMemberItem) create default domain member relation
void	createDomainMemberRelation(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) create domain member relation in the given baseset
void	createExplicitDimensionDomainRelation(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, java.lang.String roleUriUserPurpose) create explicit dimension domain relation for the given baseset
Item	createExplicitDimensionItem(FullyQualifiedName targetName, XbrlType type, Item headExplicitDimensionItem) create an explicit dimension
void	createHasHypercubeRelation(Item primaryItem, Item hypercubeItem, java.lang.String roleUriUserPurpose, java.lang.String contextElement) create a relation between the item and hypercube
void	createHypercubeDimensionRelation(Item primaryItem, Item hypercubeItem, Item dimensionItem, java.lang.String roleUriUserPurpose) create a hypercube dimension relation in the baseset for the given primary item
Item	createHypercubeItem(FullyQualifiedName targetName, XbrlType type, Item headHypercubeItem) create hypercube items
void	createPrimaryDomainMemberRelation(Item domainItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) create primary domain DomainMember relations
Item	createTypedDimensionItem(FullyQualifiedName targetName, XbrlType type, Item headTypedDimensionItem) create a typed dimension item
XbrlType	createTypedDomain(FullyQualifiedName targetName, XbrlType baseType) create a types domain
Arc[]	findDefaultDomainMemberRelations(Item dimensionItem, Item domainMemberItem) find default domain member relations If an argument is null, results are not filtered on that argument and all members in a population match.
Arc[]	findDomainMemberRelations(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) find domainmember relations for the given baseset If an argument is null, results are not filtered on that argument and all members in a population match.
Arc[]	findExplicitDimensionDomainRelations(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, java.lang.String roleUriUserPurpose) find explicit dimension domain relations for the given baseset If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findExplicitDimensionItems(FullyQualifiedName targetName, XbrlType type, Item headExplicitDimensionItem) find explicit dimension items If an argument is null, results are not filtered on that argument and all members in a population match.
Arc[]	findHasHypercubeRelations(Item primaryItem, Item hypercubeItem, java.lang.String roleUriUserPurpose, java.lang.String contextElement) find has hyper cube relations If an argument is null, results are not filtered on that argument and all members in a population match.
Arc[]	findHypercubeDimensionRelations(Item primairyItem, Item hypercubeItem, Item dimensionItem, java.lang.String roleUriUserPurpose) find relations between the hypercube and dimension in the baseset for the primary item If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findHypercubeItems(FullyQualifiedName targetName, XbrlType type, Item headHypercubeItem) find hypercube items If an argument is null, results are not filtered on that argument and all members in a population match.
Arc[]	findPrimaryDomainMemberRelations(Item domainItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) find primary domain DomainMember relations If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findPrimaryRelatedDomainItems(Item domainMemberItem, java.lang.String roleUriUserPurpose) primary domain Domain items If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findPrimaryRelatedDomainMemberItems(Item domainItem, java.lang.String roleUriUserPurpose) find primary domain DomainMember ietms If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedDefaultDomainMemberItems(Item dimensionItem) find default domain mebers If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedDimensionItems(Item domainMemberItem) find dimensions that use the default domainmember If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedDimensionItems(Item primaryItem, Item hypercubeItem, java.lang.String roleUriUserPurpose) find dimension used in the given hypercube in the baseset for the primary item If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedDomainItems(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) find related domains for the given baseset If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedDomainMemberItems(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, java.lang.String roleUriUserPurpose) find related domainmembers for the given baseset If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedExplicitDimensionItems(Item primaryItem, Item hypercubeItem, Item domainItem, java.lang.String roleUriUserPurpose) find related explicit dimensions for the given baseset If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedExplicitDomainItems(Item primaryItem, Item hypercubeItem, Item dimensionItem, java.lang.String roleUriUserPurpose) find related explicit domains for the given baseset If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedHypercubeItems(Item primaryItem, Item dimensionItem, java.lang.String roleUriUserPurpose) find hypercubes that use the given dimension in baseset for the given primary item If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedHypercubes(Item primaryItem, java.lang.String roleUriUserPurpose, java.lang.String contextElement) find hypercubes related to the given primary item If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findRelatedPrimaryItems(Item hypercubeItem, java.lang.String roleUriUserPurpose, java.lang.String contextElement) find primary items that use the given hypercube If an argument is null, results are not filtered on that argument and all members in a population match.
Item[]	findTypedDimensionItems(FullyQualifiedName targetName, XbrlType type, Item headTypedDimensionItem) find typed dimension items If an argument is null, results are not filtered on that argument and all members in a population match.
XbrlType[]	findTypedDomains(FullyQualifiedName targetName, XbrlType baseType) find types domains If an argument is null, results are not filtered on that argument and all members in a population match.
TaxonomySchema	getCreatedDimensionalTaxonomySchemaDocument() get created content for the created or extended taxonomy with the dimensional concepts
TaxonomySchema	getCreatedTemplateTaxonomySchemaDocument() get created content for the created or extended taxonomy that relates dimensional linkbases with primary and dimensional taxonomy schemas.
void	removeDefaultDomainMemberRelation(Item dimensionItem, Item domainMemberItem) remove domain meber relation
void	removeDomainMemberRelation(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) remove domain member relation in the given baseset
void	removeExplicitDimensionDomainRelation(Item primaryItem, Item hypercubeItem, Item dimensionItem, Item domainItem, java.lang.String roleUriUserPurpose) remove the dimension domain relation form the given baseset
void	removeHasHypercubeRelation(Item primaryItem, Item hypercubeItem, java.lang.String roleUriUserPurpose, java.lang.String contextElement) remove the relation between the item and the hypercube
void	removeHypercubeDimensionRelation(Item primaryItem, Item hypercubeItem, Item dimensionItem, java.lang.String roleUriUserPurpose) remove the hypercube dimension relation in the baseset for the given primary item
void	removePrimaryDomainMemberRelation(Item domainItem, Item domainMemberItem, java.lang.String roleUriUserPurpose) remove primary domain DomainMember relations

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

createArcroleType, createItemConcept, createLabel, createLabelRelation, createReference, createReferencePart, createReferencePartDeclaration, createReferenceRelation, createRelation, createRoleType, createTupleConcept, createType, createType, discoverTaxonomySet, findArcroleTypes, findItemConcepts, findLabels, findReferencePartDeclartaions, findReferenceParts, findReferences, findRelatedChildConcepts, findRelatedParentConcepts, findRelations, findRoleTypes, findTupleConcepts, findTypes, getCreatedLinkbaseDocuments, getCreatedPrimaryTaxonomySchemaDocument, getName, getNameSpace, removeLabelRelation, removeReferenceRelation, removeRelation

Method Detail

findTypedDomains

XbrlType[] findTypedDomains(FullyQualifiedName targetName,
                            XbrlType baseType)

find types domains
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

targetName -

baseType -

Returns:

createTypedDomain

XbrlType createTypedDomain(FullyQualifiedName targetName,
                           XbrlType baseType)

create a types domain

Parameters:

targetName -

baseType -

Returns:

findHypercubeItems

Item[] findHypercubeItems(FullyQualifiedName targetName,
                          XbrlType type,
                          Item headHypercubeItem)

find hypercube items
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

targetName -

type -

headHypercubeItem -

Returns:

createHypercubeItem

Item createHypercubeItem(FullyQualifiedName targetName,
                         XbrlType type,
                         Item headHypercubeItem)

create hypercube items

Parameters:

targetName -

type -

headHypercubeItem -

Returns:

findExplicitDimensionItems

Item[] findExplicitDimensionItems(FullyQualifiedName targetName,
                                  XbrlType type,
                                  Item headExplicitDimensionItem)

find explicit dimension items
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

targetName -

type -

headExplicitDimensionItem -

Returns:

createExplicitDimensionItem

Item createExplicitDimensionItem(FullyQualifiedName targetName,
                                 XbrlType type,
                                 Item headExplicitDimensionItem)

create an explicit dimension

Parameters:

targetName -

type -

headExplicitDimensionItem -

Returns:

findTypedDimensionItems

Item[] findTypedDimensionItems(FullyQualifiedName targetName,
                               XbrlType type,
                               Item headTypedDimensionItem)

find typed dimension items
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

targetName -

type -

headTypedDimensionItem -

Returns:

createTypedDimensionItem

Item createTypedDimensionItem(FullyQualifiedName targetName,
                              XbrlType type,
                              Item headTypedDimensionItem)

create a typed dimension item

Parameters:

targetName -

type -

headTypedDimensionItem -

Returns:

findHasHypercubeRelations

Arc[] findHasHypercubeRelations(Item primaryItem,
                                Item hypercubeItem,
                                java.lang.String roleUriUserPurpose,
                                java.lang.String contextElement)

find has hyper cube relations
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

roleUriUserPurpose -

contextElement -

Returns:

findRelatedHypercubes

Item[] findRelatedHypercubes(Item primaryItem,
                             java.lang.String roleUriUserPurpose,
                             java.lang.String contextElement)

find hypercubes related to the given primary item
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

roleUriUserPurpose -

contextElement -

Returns:

findRelatedPrimaryItems

Item[] findRelatedPrimaryItems(Item hypercubeItem,
                               java.lang.String roleUriUserPurpose,
                               java.lang.String contextElement)

find primary items that use the given hypercube
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

hypercubeItem -

roleUriUserPurpose -

contextElement -

Returns:

createHasHypercubeRelation

void createHasHypercubeRelation(Item primaryItem,
                                Item hypercubeItem,
                                java.lang.String roleUriUserPurpose,
                                java.lang.String contextElement)

create a relation between the item and hypercube

Parameters:

primaryItem -

hypercubeItem -

roleUriUserPurpose -

contextElement -

removeHasHypercubeRelation

void removeHasHypercubeRelation(Item primaryItem,
                                Item hypercubeItem,
                                java.lang.String roleUriUserPurpose,
                                java.lang.String contextElement)

remove the relation between the item and the hypercube

Parameters:

primaryItem -

hypercubeItem -

roleUriUserPurpose -

contextElement -

findHypercubeDimensionRelations

Arc[] findHypercubeDimensionRelations(Item primairyItem,
                                      Item hypercubeItem,
                                      Item dimensionItem,
                                      java.lang.String roleUriUserPurpose)

find relations between the hypercube and dimension in the baseset for the primary item
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

roleUriUserPurpose -

Returns:

findRelatedDimensionItems

Item[] findRelatedDimensionItems(Item primaryItem,
                                 Item hypercubeItem,
                                 java.lang.String roleUriUserPurpose)

find dimension used in the given hypercube in the baseset for the primary item
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

roleUriUserPurpose -

Returns:

findRelatedHypercubeItems

Item[] findRelatedHypercubeItems(Item primaryItem,
                                 Item dimensionItem,
                                 java.lang.String roleUriUserPurpose)

find hypercubes that use the given dimension in baseset for the given primary item
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

dimensionItem -

roleUriUserPurpose -

Returns:

createHypercubeDimensionRelation

void createHypercubeDimensionRelation(Item primaryItem,
                                      Item hypercubeItem,
                                      Item dimensionItem,
                                      java.lang.String roleUriUserPurpose)

create a hypercube dimension relation in the baseset for the given primary item

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

roleUriUserPurpose -

removeHypercubeDimensionRelation

void removeHypercubeDimensionRelation(Item primaryItem,
                                      Item hypercubeItem,
                                      Item dimensionItem,
                                      java.lang.String roleUriUserPurpose)

remove the hypercube dimension relation in the baseset for the given primary item

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

roleUriUserPurpose -

findExplicitDimensionDomainRelations

Arc[] findExplicitDimensionDomainRelations(Item primaryItem,
                                           Item hypercubeItem,
                                           Item dimensionItem,
                                           Item domainItem,
                                           java.lang.String roleUriUserPurpose)

find explicit dimension domain relations for the given baseset
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

roleUriUserPurpose -

Returns:

findRelatedExplicitDomainItems

Item[] findRelatedExplicitDomainItems(Item primaryItem,
                                      Item hypercubeItem,
                                      Item dimensionItem,
                                      java.lang.String roleUriUserPurpose)

find related explicit domains for the given baseset
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

roleUriUserPurpose -

Returns:

findRelatedExplicitDimensionItems

Item[] findRelatedExplicitDimensionItems(Item primaryItem,
                                         Item hypercubeItem,
                                         Item domainItem,
                                         java.lang.String roleUriUserPurpose)

find related explicit dimensions for the given baseset
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

domainItem -

roleUriUserPurpose -

Returns:

createExplicitDimensionDomainRelation

void createExplicitDimensionDomainRelation(Item primaryItem,
                                           Item hypercubeItem,
                                           Item dimensionItem,
                                           Item domainItem,
                                           java.lang.String roleUriUserPurpose)

create explicit dimension domain relation for the given baseset

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

roleUriUserPurpose -

removeExplicitDimensionDomainRelation

void removeExplicitDimensionDomainRelation(Item primaryItem,
                                           Item hypercubeItem,
                                           Item dimensionItem,
                                           Item domainItem,
                                           java.lang.String roleUriUserPurpose)

remove the dimension domain relation form the given baseset

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

roleUriUserPurpose -

findDomainMemberRelations

Arc[] findDomainMemberRelations(Item primaryItem,
                                Item hypercubeItem,
                                Item dimensionItem,
                                Item domainItem,
                                Item domainMemberItem,
                                java.lang.String roleUriUserPurpose)

find domainmember relations for the given baseset
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

domainMemberItem -

roleUriUserPurpose -

Returns:

findRelatedDomainMemberItems

Item[] findRelatedDomainMemberItems(Item primaryItem,
                                    Item hypercubeItem,
                                    Item dimensionItem,
                                    Item domainItem,
                                    java.lang.String roleUriUserPurpose)

find related domainmembers for the given baseset
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

roleUriUserPurpose -

Returns:

findRelatedDomainItems

Item[] findRelatedDomainItems(Item primaryItem,
                              Item hypercubeItem,
                              Item dimensionItem,
                              Item domainMemberItem,
                              java.lang.String roleUriUserPurpose)

find related domains for the given baseset
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainMemberItem -

roleUriUserPurpose -

Returns:

createDomainMemberRelation

void createDomainMemberRelation(Item primaryItem,
                                Item hypercubeItem,
                                Item dimensionItem,
                                Item domainItem,
                                Item domainMemberItem,
                                java.lang.String roleUriUserPurpose)

create domain member relation in the given baseset

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

domainMemberItem -

roleUriUserPurpose -

removeDomainMemberRelation

void removeDomainMemberRelation(Item primaryItem,
                                Item hypercubeItem,
                                Item dimensionItem,
                                Item domainItem,
                                Item domainMemberItem,
                                java.lang.String roleUriUserPurpose)

remove domain member relation in the given baseset

Parameters:

primaryItem -

hypercubeItem -

dimensionItem -

domainItem -

domainMemberItem -

roleUriUserPurpose -

findDefaultDomainMemberRelations

Arc[] findDefaultDomainMemberRelations(Item dimensionItem,
                                       Item domainMemberItem)

find default domain member relations
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

dimensionItem -

domainMemberItem -

Returns:

findRelatedDefaultDomainMemberItems

Item[] findRelatedDefaultDomainMemberItems(Item dimensionItem)

find default domain mebers
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

dimensionItem -

Returns:

findRelatedDimensionItems

Item[] findRelatedDimensionItems(Item domainMemberItem)

find dimensions that use the default domainmember
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

domainMemberItem -

Returns:

createDefaultDomainMemberRelation

void createDefaultDomainMemberRelation(Item dimensionItem,
                                       Item domainMemberItem)

create default domain member relation

Parameters:

dimensionItem -

domainMemberItem -

removeDefaultDomainMemberRelation

void removeDefaultDomainMemberRelation(Item dimensionItem,
                                       Item domainMemberItem)

remove domain meber relation

Parameters:

dimensionItem -

domainMemberItem -

findPrimaryDomainMemberRelations

Arc[] findPrimaryDomainMemberRelations(Item domainItem,
                                       Item domainMemberItem,
                                       java.lang.String roleUriUserPurpose)

find primary domain DomainMember relations
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

domainItem -

domainMemberItem -

roleUriUserPurpose -

Returns:

findPrimaryRelatedDomainMemberItems

Item[] findPrimaryRelatedDomainMemberItems(Item domainItem,
                                           java.lang.String roleUriUserPurpose)

find primary domain DomainMember ietms
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

domainItem -

roleUriUserPurpose -

Returns:

findPrimaryRelatedDomainItems

Item[] findPrimaryRelatedDomainItems(Item domainMemberItem,
                                     java.lang.String roleUriUserPurpose)

primary domain Domain items
If an argument is null, results are not filtered on that argument and all members in a population match.

Parameters:

domainMemberItem -

roleUriUserPurpose -

Returns:

createPrimaryDomainMemberRelation

void createPrimaryDomainMemberRelation(Item domainItem,
                                       Item domainMemberItem,
                                       java.lang.String roleUriUserPurpose)

create primary domain DomainMember relations

Parameters:

domainItem -

domainMemberItem -

roleUriUserPurpose -

removePrimaryDomainMemberRelation

void removePrimaryDomainMemberRelation(Item domainItem,
                                       Item domainMemberItem,
                                       java.lang.String roleUriUserPurpose)

remove primary domain DomainMember relations

Parameters:

domainItem -

domainMemberItem -

roleUriUserPurpose -

getCreatedDimensionalTaxonomySchemaDocument

TaxonomySchema getCreatedDimensionalTaxonomySchemaDocument()

get created content for the created or extended taxonomy with the dimensional concepts

Returns:

getCreatedTemplateTaxonomySchemaDocument

TaxonomySchema getCreatedTemplateTaxonomySchemaDocument()

get created content for the created or extended taxonomy that relates dimensional linkbases with primary and dimensional taxonomy schemas.

Returns: