org.xbrlapi.impl
Class LinkbaseImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.FragmentImpl
          org.xbrlapi.impl.LinkbaseImpl

All Implemented Interfaces:

Serializable, Comparable<XML>, Fragment, Linkbase, XML

public class LinkbaseImpl
extends FragmentImpl
implements Linkbase

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

LinkbaseImpl()

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

LinkbaseImpl

public LinkbaseImpl()

Method Detail

getArcroleRef

public SimpleLink getArcroleRef(String uri)
                         throws XBRLException

Retrieve an arcroleRef from a linkbase.

Specified by:

getArcroleRef in interface Linkbase

Parameters:

uri - The arcroleRef URI

Returns:

the required arcroleRef

Throws:

XBRLException - if the arcroleRef is not part of the linkbase

See Also:

Linkbase.getArcroleRef(String)

getArcroleRefs

public List<SimpleLink> getArcroleRefs()
                                throws XBRLException

Gets the list of arcroleRefs in a linkbase.

Specified by:

getArcroleRefs in interface Linkbase

Returns:

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

Throws:

XBRLException

See Also:

Linkbase.getArcroleRefs()

getRoleRef

public SimpleLink getRoleRef(String uri)
                      throws XBRLException

Retrieve an roleRef from a linkbase.

Specified by:

getRoleRef in interface Linkbase

Parameters:

uri - The roleRef URI

Returns:

the required roleRef

Throws:

XBRLException - if the roleRef is not part of the linkbase

See Also:

Linkbase.getRoleRef(String)

getRoleRefs

public List<SimpleLink> getRoleRefs()
                             throws XBRLException

Gets the list of roleRefs in a linkbase.

Specified by:

getRoleRefs in interface Linkbase

Returns:

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

Throws:

XBRLException

See Also:

Linkbase.getRoleRefs()

getExtendedLinks

public List<ExtendedLink> getExtendedLinks()
                                    throws XBRLException

Description copied from interface: Linkbase

Gets the list of extended links in a linkbase

Specified by:

getExtendedLinks in interface Linkbase

Returns:

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

Throws:

XBRLException

See Also:

Linkbase.getExtendedLinks()

getExtendedLinks

public List<ExtendedLink> getExtendedLinks(QName qname)
                                    throws XBRLException

Specified by:

getExtendedLinks in interface Linkbase

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

See Also:

Linkbase.getExtendedLinks(QName)

getDocumentations

public 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.

Specified by:

getDocumentations in interface Linkbase

Throws:

XBRLException

See Also:

Linkbase.getDocumentations()

removeDocumentation

public void removeDocumentation(Fragment documentation)
                         throws XBRLException

Remove a link documentation child fragment from the linkbase.

Specified by:

removeDocumentation in interface Linkbase

Parameters:

documentation - The documentation fragment to be removed.

Throws:

XBRLException

See Also:

Linkbase.removeDocumentation(Fragment)

getExtendedLinkQNames

public Set<QName> getExtendedLinkQNames()
                                 throws XBRLException

Specified by:

getExtendedLinkQNames in interface Linkbase

Returns:

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

Throws:

XBRLException

See Also:

Linkbase.getExtendedLinkQNames()