org.xbrlapi
Interface Concept

All Superinterfaces:

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

All Known Subinterfaces:

Dimension, ExplicitDimension, Hypercube, TypedDimension, XDTConcept

All Known Implementing Classes:

ConceptImpl, DimensionImpl, ExplicitDimensionImpl, HypercubeImpl, TypedDimensionImpl, XDTConceptImpl

public interface Concept
extends ElementDeclaration

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getBalance() Get the concept's balance, one of debit or credit or null if the balance is not defined.
long	getFactCount()
Set<String>	getFactIndices()
List<Fact>	getFacts()
String	getPeriodType()
List<URI>	getPresentationNetworkLinkroles()
List<Fact>	getRootFacts()
boolean	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

getPeriodType

String getPeriodType()
                     throws XBRLException

Returns:

the period attribute value (one of instant or duration) for concepts in the XBRL item substitution group and null for tuple concepts.

Throws:

XBRLException - if the periodType is missing for concepts in the XBRL item substitution group.

getBalance

String getBalance()
                  throws XBRLException

Get the concept's balance, one of debit or credit or null if the balance is not defined.

Throws:

XBRLException

isNumeric

boolean isNumeric()
                  throws XBRLException

Returns:

true if the concept is numeric.

Throws:

XBRLException

getFacts

List<Fact> getFacts()
                    throws XBRLException

Returns:

the list of facts in the data store giving values for this concept

Throws:

XBRLException

getRootFacts

List<Fact> getRootFacts()
                        throws XBRLException

Returns:

the list of root-level facts in the data store giving values for this concept. Root-level facts are facts that are children of XBRL-instance elements.

Throws:

XBRLException

getFactCount

long getFactCount()
                  throws XBRLException

Returns:

the number of facts for this concept

Throws:

XBRLException

getFactIndices

Set<String> getFactIndices()
                           throws XBRLException

Returns:

the set of indices of facts for this concept

Throws:

XBRLException

getPresentationNetworkLinkroles

List<URI> getPresentationNetworkLinkroles()
                                          throws XBRLException

Returns:

the list of extended link roles for the presentation networks involving this concept as a source or a target.

Throws:

XBRLException