org.xbrlapi
Interface OpenContextComponent

All Superinterfaces:

Comparable<XML>, ContextComponent, Fragment, Serializable, XML

All Known Subinterfaces:

Scenario, Segment

All Known Implementing Classes:

OpenContextComponentImpl, ScenarioImpl, SegmentImpl

public interface OpenContextComponent
extends ContextComponent

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

boolean	equals(OpenContextComponent other) Test c-equality of this open context component and another.
List<Element>	getChildElements()
NodeList	getComplexContent() Gets the complex content

Methods inherited from interface org.xbrlapi.ContextComponent

getContext

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

getComplexContent

NodeList getComplexContent()
                           throws XBRLException

Gets the complex content

Returns:

the complex content contained by the open context component as a linked list of complex content XML nodes

Throws:

XBRLException

getChildElements

List<Element> getChildElements()
                               throws XBRLException

Returns:

the list of child elements.

Throws:

XBRLException

equals

boolean equals(OpenContextComponent other)
               throws XBRLException

Test c-equality of this open context component and another.

Parameters:

other - the other open context component.

Returns:

true if the two components are c-equal and false otherwise.

Throws:

XBRLException