org.xbrlapi.xdt
Interface Hypercube

All Superinterfaces:

Comparable<XML>, Concept, ElementDeclaration, Fragment, SchemaContent, SchemaContentDeclaration, SchemaDeclaration, Serializable, XDTConcept, XML

All Known Implementing Classes:

HypercubeImpl

public interface Hypercube
extends XDTConcept

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<Dimension>	getDimensions()
List<Dimension>	getDimensions(URI linkRole)
SortedSet<Relationship>	getRelationshipsToDimensions(URI linkRole)

Methods inherited from interface org.xbrlapi.Concept

getBalance, getFactCount, getFactIndices, getFacts, getPeriodType, getPresentationNetworkLinkroles, getRootFacts, isNumeric

Methods inherited from interface org.xbrlapi.ElementDeclaration

getLocalComplexType, getMaxOccurs, getMinOccurs, getSubstitutionGroupDeclaration, getSubstitutionGroupLocalname, getSubstitutionGroupNamespace, getSubstitutionGroupNamespaceAlias, getSubstitutionGroupQName, hasLocalComplexType, hasSubstitutionGroup, isAbstract, isBlockingExtension, isBlockingRestriction, isBlockingSubstitution, isFinalForExtension, isFinalForRestriction, isItem, isNillable, isTuple, substitutesFor

Methods inherited from interface org.xbrlapi.SchemaContentDeclaration

getDefault, getFixed, getForm, getLocalType, getTypeDeclaration, getTypeLocalname, getTypeNamespace, getTypeNamespaceAlias, getTypeQName, hasLocalType, hasTypeReference, isFixed, isGlobal

Methods inherited from interface org.xbrlapi.SchemaDeclaration

getName, getReferencedSchemaDeclaration, getReferenceLocalname, getReferenceNamespace, getReferenceNamespaceAlias, getReferenceQName, hasReference

Methods inherited from interface org.xbrlapi.SchemaContent

getAnnotations, getOtherAttribute, getOtherAttributes, getSchema, getSchemaId, getTargetNamespace, hasOtherAttribute

Methods inherited from interface org.xbrlapi.Fragment

appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, getLanguage, getLanguage, getLanguageName, getLanguageName, getLocalname, getLocalnameFromQName, getNamespace, getNamespaceFromQName, getParent, getParentElement, getParentIndex, getPrefixFromQName, getReferences, getReferencesWithLanguage, getReferencesWithLanguageAndResourceRoleAndLinkRole, getReferencesWithLanguageAndRole, getReferencesWithResourceRole, getReferencingLocators, getSequenceToParentElement, getSequenceToParentElementAsString, getSimpleLinks, getURI, getXPath, getXPointerExpression, isAncestorOf, isChild, isNewFragment, isRoot, setParentIndex, setSequenceToParentElement, setURI

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDimensions

List<Dimension> getDimensions()
                              throws XBRLException

Returns:

a list of the hypercube's XDT dimensions. This gets all of the dimensions associated with the hypercube, regardless of the link role that the relationship to the dimension is defined in.

Throws:

XBRLException

getDimensions

List<Dimension> getDimensions(URI linkRole)
                              throws XBRLException

Parameters:

linkRole - the link role URI to use when selecting the dimensions of the hypercube.

Returns:

a list of the hypercube's XDT dimensions defined by hypercube-dimension relationships with link role values as specified.

Throws:

XBRLException

getRelationshipsToDimensions

SortedSet<Relationship> getRelationshipsToDimensions(URI linkRole)
                                                     throws XBRLException

Parameters:

linkRole - the link role URI to use when selecting the dimensions of the hypercube.

Returns:

a list of the active (not prohibited or overridden) relationships to the hypercube's XDT dimensions with link role values as specified.

Throws:

XBRLException