org.xbrlapi
Interface ExtendedLink

All Superinterfaces:

Comparable<XML>, Fragment, Link, Serializable, Xlink, XML

All Known Implementing Classes:

ExtendedLinkImpl

public interface ExtendedLink
extends Link

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Map<String,List<String>>	getArcEndIndicesByLabel()
<E extends ArcEnd> List<E>	getArcEndsWithLabel(String label) Get the list of Arc Ends (locators or resources) with a specified label in the extended link.
List<Arc>	getArcs() Get the list of arcs contained by the extended link.
List<Arc>	getArcsWithArcrole(URI arcrole)
List<Arc>	getArcsWithFromLabel(String from)
List<Arc>	getArcsWithFromLabelAndArcrole(String from, URI arcrole)
List<Arc>	getArcsWithToLabel(String to)
List<Arc>	getArcsWithToLabelAndArcrole(String to, URI arcrole)
List<XlinkDocumentation>	getDocumentations() Get the list of documentation fragments contained by the extended link.
List<Locator>	getLocators() Get the list of locators contained by the extended link.
List<Locator>	getLocatorsWithHref(String href) Get the list of locators in the extended link with a specified absolute HREF.
List<Locator>	getLocatorsWithLabel(String label) Get the list of locators with a specified label in the extended link.
Map<String,String>	getLocatorTargetIndices()
List<Resource>	getResources() Get the list of resources contained by the extended link.
List<Resource>	getResourcesWithLabel(String label) Get the list of resources with the specified label.

Methods inherited from interface org.xbrlapi.Link

getLinkRole

Methods inherited from interface org.xbrlapi.Xlink

getAttribute, getAttribute, getTitleAttribute, getTitleElement, getTitleElements, getXlinkType

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

getLocators

List<Locator> getLocators()
                          throws XBRLException

Get the list of locators contained by the extended link. Returns null if the extended link contains no locators.

Throws:

XBRLException

getArcEndsWithLabel

<E extends ArcEnd> List<E> getArcEndsWithLabel(String label)
                                           throws XBRLException

Get the list of Arc Ends (locators or resources) with a specified label in the extended link.

Parameters:

label - The string value of the xlink:label attribute on the arc ends.

Returns:

the list of matching fragments or the empty list if none are found.

Throws:

XBRLException

getLocatorsWithLabel

List<Locator> getLocatorsWithLabel(String label)
                                   throws XBRLException

Get the list of locators with a specified label in the extended link.

Parameters:

label - The string value of the xlink:label attribute on the locator.

Returns:

the list of matching locator fragments or the empty list if none are found.

Throws:

XBRLException

getLocatorsWithHref

List<Locator> getLocatorsWithHref(String href)
                                  throws XBRLException

Get the list of locators in the extended link with a specified absolute HREF.

Parameters:

href - The resolved value of the xlink:href attribute on the locator.

Returns:

the list of matching locator fragments or the empty list if none are found.

Throws:

XBRLException

getArcs

List<Arc> getArcs()
                  throws XBRLException

Get the list of arcs contained by the extended link.

Returns:

the list of matching arc fragments or the empty list if none are found.

Throws:

XBRLException

getArcsWithArcrole

List<Arc> getArcsWithArcrole(URI arcrole)
                             throws XBRLException

Parameters:

arcrole - The arcrole of the required arcs. Get the list of arcs with the given arcrole that are contained by the extended link.

Returns:

the list of matching arc fragments or the empty list if none are found.

Throws:

XBRLException

getArcsWithFromLabel

List<Arc> getArcsWithFromLabel(String from)
                               throws XBRLException

Parameters:

from - The required value of the xlink:from attribute of the arcs.

Returns:

the list of arcs with a given xlink:from label in extended link. or the empty list if none are found.

Throws:

XBRLException

getArcsWithFromLabelAndArcrole

List<Arc> getArcsWithFromLabelAndArcrole(String from,
                                         URI arcrole)
                                         throws XBRLException

Parameters:

from - The required value of the xlink:from attribute of the arcs.

arcrole - The arcrole value for the arcs being sought.

Returns:

the list of arcs in the extended link starting at the given xlink label and arcrole value or the empty list if none are found.

Throws:

XBRLException

getArcsWithToLabel

List<Arc> getArcsWithToLabel(String to)
                             throws XBRLException

Parameters:

to - The required value of the xlink:to attribute of the arcs.

Returns:

the list of arcs with a given xlink:from label in extended link or the empty list if none are found.

Throws:

XBRLException

getArcsWithToLabelAndArcrole

List<Arc> getArcsWithToLabelAndArcrole(String to,
                                       URI arcrole)
                                       throws XBRLException

Parameters:

to - The required value of the xlink:to attribute of the arcs.

arcrole - The arcrole value for the arcs being sought.

Returns:

the list of arcs in the extended link ending at the given xlink label and arcrole value or the empty list if none are found.

Throws:

XBRLException

getResources

List<Resource> getResources()
                            throws XBRLException

Get the list of resources contained by the extended link.

Returns:

the list of resource fragments in the extended link.

Throws:

XBRLException

getResourcesWithLabel

List<Resource> getResourcesWithLabel(String label)
                                     throws XBRLException

Get the list of resources with the specified label.

Parameters:

label - The value of the label used to select resources in the extended link.

Returns:

the list of resource fragments with the given xlink:label attribute value.

Throws:

XBRLException

getDocumentations

List<XlinkDocumentation> getDocumentations()
                                           throws XBRLException

Get the list of documentation fragments contained by the extended link. Returns the list of documentation fragments in the extended link.

Throws:

XBRLException

getArcEndIndicesByLabel

Map<String,List<String>> getArcEndIndicesByLabel()
                                                 throws XBRLException

Returns:

A map, indexed by XLink label, of the XLink arc end indices in an extended link.

Throws:

XBRLException

getLocatorTargetIndices

Map<String,String> getLocatorTargetIndices()
                                           throws XBRLException

Returns:

a map of locator target indices indexed by the indices of the locators that target them.

Throws:

XBRLException