org.xbrlapi.xdt

Class ExplicitDimensionImpl

java.lang.Object

org.xbrlapi.impl.XMLImpl

org.xbrlapi.impl.FragmentImpl

org.xbrlapi.impl.SchemaContentImpl

org.xbrlapi.impl.SchemaDeclarationImpl

org.xbrlapi.impl.SchemaContentDeclarationImpl

org.xbrlapi.impl.ElementDeclarationImpl

org.xbrlapi.impl.ConceptImpl

org.xbrlapi.xdt.XDTConceptImpl

org.xbrlapi.xdt.DimensionImpl

org.xbrlapi.xdt.ExplicitDimensionImpl

All Implemented Interfaces:

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

public class ExplicitDimensionImpl
extends DimensionImpl
implements ExplicitDimension

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExplicitDimensionImpl()

Method Summary

Methods

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

Methods inherited from class org.xbrlapi.xdt.DimensionImpl

isExplicitDimension, isTypedDimension

Methods inherited from class org.xbrlapi.impl.ConceptImpl

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

Methods inherited from class org.xbrlapi.impl.ElementDeclarationImpl

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

Methods inherited from class org.xbrlapi.impl.SchemaContentDeclarationImpl

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

Methods inherited from class org.xbrlapi.impl.SchemaDeclarationImpl

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

Methods inherited from class org.xbrlapi.impl.SchemaContentImpl

getAnnotations, getOtherAttribute, getOtherAttributes, getSchemaId, getTargetNamespace, hasOtherAttribute

Methods inherited from class org.xbrlapi.impl.FragmentImpl

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 class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, 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 class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

ExplicitDimensionImpl

public ExplicitDimensionImpl()

Method Detail

getDefaultDomainMember

public Concept getDefaultDomainMember()
                               throws XBRLException

Specified by:

getDefaultDomainMember in interface ExplicitDimension

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.

See Also:

ExplicitDimension.getDefaultDomainMember()

hasDefaultDomainMember

public boolean hasDefaultDomainMember()
                               throws XBRLException

Specified by:

hasDefaultDomainMember in interface ExplicitDimension

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

See Also:

ExplicitDimension.hasDefaultDomainMember()

getRelationshipsToDomains

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

Specified by:

getRelationshipsToDomains in interface ExplicitDimension

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

See Also:

ExplicitDimension.getRelationshipsToDomains(String)

getDomainMemberRelationshipsFrom

public static java.util.SortedSet<Relationship> getDomainMemberRelationshipsFrom(java.lang.String linkRole,
                                                                 Concept concept)
                                                                          throws XBRLException

Parameters:

linkRole - THe link role of the relationships to retrieve

concept - The concept that the domain-member relationships are to run from.

Returns:

the order-sorted set of domain member relationships with the given link role from the given concept.

Throws:

XBRLException