org.xbrlapi
Interface Linkbase

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Implementing Classes:

LinkbaseImpl

public interface Linkbase
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

SimpleLink	getArcroleRef(String uri) Retrieve an arcroleRef from a linkbase.
List<SimpleLink>	getArcroleRefs() Gets the list of arcroleRefs in a linkbase.
List<XlinkDocumentation>	getDocumentations() Get the list of documentation fragments that are children of the linkbase.
Set<QName>	getExtendedLinkQNames()
List<ExtendedLink>	getExtendedLinks() Gets the list of extended links in a linkbase
List<ExtendedLink>	getExtendedLinks(QName qname)
SimpleLink	getRoleRef(String uri) Retrieve an roleRef from a linkbase.
List<SimpleLink>	getRoleRefs() Gets the list of roleRefs in a linkbase.
void	removeDocumentation(Fragment documentation) Remove a link documentation child fragment from the linkbase.

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

getArcroleRef

SimpleLink getArcroleRef(String uri)
                         throws XBRLException

Retrieve an arcroleRef from a linkbase.

Parameters:

uri - The arcroleRef URI

Returns:

the required arcroleRef

Throws:

XBRLException - if the arcroleRef is not part of the linkbase

getArcroleRefs

List<SimpleLink> getArcroleRefs()
                                throws XBRLException

Gets the list of arcroleRefs in a linkbase.

Returns:

list of arcroleRef fragments that are children of the linkbase. The list can be empty.

Throws:

XBRLException

getRoleRef

SimpleLink getRoleRef(String uri)
                      throws XBRLException

Retrieve an roleRef from a linkbase.

Parameters:

uri - The roleRef URI

Returns:

the required roleRef

Throws:

XBRLException - if the roleRef is not part of the linkbase

getRoleRefs

List<SimpleLink> getRoleRefs()
                             throws XBRLException

Gets the list of roleRefs in a linkbase.

Returns:

list of roleRef fragments that are children of the linkbase. The list can be empty.

Throws:

XBRLException

getExtendedLinks

List<ExtendedLink> getExtendedLinks()
                                    throws XBRLException

Gets the list of extended links in a linkbase

Returns:

the list of extended links in the linkbase. The extended links are ordered by their namespace and then local name.

Throws:

XBRLException

getExtendedLinks

List<ExtendedLink> getExtendedLinks(QName qname)
                                    throws XBRLException

Parameters:

qname - the qname of the element that is one of the required extended links.

Returns:

the list of extended links in the linkbase that match the specified criteria.

Throws:

XBRLException

getDocumentations

List<XlinkDocumentation> getDocumentations()
                                           throws XBRLException

Get the list of documentation fragments that are children of the linkbase. Returns the list of documentation fragments in the linkbase.

Throws:

XBRLException

removeDocumentation

void removeDocumentation(Fragment documentation)
                         throws XBRLException

Remove a link documentation child fragment from the linkbase.

Parameters:

documentation - The documentation fragment to be removed.

Throws:

XBRLException

getExtendedLinkQNames

Set<QName> getExtendedLinkQNames()
                                 throws XBRLException

Returns:

the set of different extended link QNames for the extended links contained in this linkbase.

Throws:

XBRLException