org.xbrlapi.impl
Class ConceptImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

XDTConceptImpl

public class ConceptImpl
extends ElementDeclarationImpl
implements Concept

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

ConceptImpl()

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()
Schema	getSchema() Retrieves the fragment that is the schema for this concept.
boolean	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, finalize, 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

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

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, 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

ConceptImpl

public ConceptImpl()

Method Detail

getPeriodType

public String getPeriodType()
                     throws XBRLException

Specified by:

getPeriodType in interface Concept

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.

See Also:

Concept.getPeriodType()

getBalance

public String getBalance()
                  throws XBRLException

Description copied from interface: Concept

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

Specified by:

getBalance in interface Concept

Throws:

XBRLException

See Also:

Concept.getBalance()

getSchema

public Schema getSchema()
                 throws XBRLException

Retrieves the fragment that is the schema for this concept.

Specified by:

getSchema in interface SchemaContent

Overrides:

getSchema in class SchemaContentImpl

Returns:

a Schema fragment for the parent schema of this concept.

Throws:

XBRLException

See Also:

SchemaContent.getSchema()

getFacts

public List<Fact> getFacts()
                    throws XBRLException

Specified by:

getFacts in interface Concept

Returns:

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

Throws:

XBRLException

See Also:

Concept.getFacts()

getRootFacts

public List<Fact> getRootFacts()
                        throws XBRLException

Specified by:

getRootFacts in interface Concept

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

See Also:

Concept.getRootFacts()

getFactCount

public long getFactCount()
                  throws XBRLException

Specified by:

getFactCount in interface Concept

Returns:

the number of facts for this concept

Throws:

XBRLException

See Also:

Concept.getFactCount()

getFactIndices

public Set<String> getFactIndices()
                           throws XBRLException

Specified by:

getFactIndices in interface Concept

Returns:

the set of indices of facts for this concept

Throws:

XBRLException

See Also:

Concept.getFactIndices()

getPresentationNetworkLinkroles

public List<URI> getPresentationNetworkLinkroles()
                                          throws XBRLException

Specified by:

getPresentationNetworkLinkroles in interface Concept

Returns:

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

Throws:

XBRLException

See Also:

Concept.getPresentationNetworkLinkroles()

isNumeric

public boolean isNumeric()
                  throws XBRLException

Specified by:

isNumeric in interface Concept

Returns:

true if the concept is numeric.

Throws:

XBRLException

See Also:

Concept.isNumeric()