org.xbrlapi.xdt

Interface ExplicitDimension

All Superinterfaces:

java.lang.Comparable<XML>, Concept, Dimension, ElementDeclaration, Fragment, SchemaContent, SchemaContentDeclaration, SchemaDeclaration, java.io.Serializable, XDTConcept, XML

All Known Implementing Classes:

ExplicitDimensionImpl

public interface ExplicitDimension
extends Dimension

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
Concept	getDefaultDomainMember()
java.util.SortedSet<Relationship>	getRelationshipsToDomains(java.lang.String linkRole)
boolean	hasDefaultDomainMember()

Methods inherited from interface org.xbrlapi.xdt.Dimension

isExplicitDimension, isTypedDimension

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

hasDefaultDomainMember

boolean hasDefaultDomainMember()
                               throws XBRLException

Returns:

true if the explicit dimension has a default domain member and false otherwise (including if it has more than one default domain member, thus undermining the default property of the indicated defaults.

Throws:

XBRLException

getDefaultDomainMember

Concept getDefaultDomainMember()
                               throws XBRLException

Returns:

the default domain member for the explicit dimension.

Throws:

XBRLException - if the explicit dimension does not have a default domain member or if it has more than one default domain members.

getRelationshipsToDomains

java.util.SortedSet<Relationship> getRelationshipsToDomains(java.lang.String linkRole)
                                                            throws XBRLException

Parameters:

linkRole - The link role of the relationships to the domains from this dimension.

Returns:

the order-based sorted set of relationships to the domains from this dimension.

Throws:

XBRLException