org.xbrlapi
Interface ArcEnd

All Superinterfaces:

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

All Known Subinterfaces:

EntityResource, FootnoteResource, LabelResource, Locator, MixedContentResource, ReferenceResource, Resource

All Known Implementing Classes:

ArcEndImpl, EntityResourceImpl, FootnoteResourceImpl, LabelResourceImpl, LocatorImpl, MixedContentResourceImpl, ReferenceResourceImpl, ResourceImpl

public interface ArcEnd
extends ExtendedLinkContent

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getArcEndId() Get the id attribute value.
List<Arc>	getArcsFrom()
List<Arc>	getArcsFromWithArcrole(URI arcrole)
List<Arc>	getArcsTo()
List<Arc>	getArcsToWithArcrole(URI arcrole)
String	getLabel() Get the xlink:label attribute value.
String	getRole() Get the xlink:role attribute value.

Methods inherited from interface org.xbrlapi.ExtendedLinkContent

getExtendedLink

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, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, 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, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLabel

String getLabel()
                throws XBRLException

Get the xlink:label attribute value.

Returns:

the xlink:label attribute value.

Throws:

XBRLException - if the xlink:label attribute does not exist.

getRole

String getRole()
               throws XBRLException

Get the xlink:role attribute value.

Returns:

the value of the XLink role attribute on the ArcEnd fragment or null if no such attribute exists.

Throws:

XBRLException

getArcEndId

String getArcEndId()
                   throws XBRLException

Get the id attribute value.

Returns:

the value of the id attribute or null if no such attribute exists.

Throws:

XBRLException

getArcsFrom

List<Arc> getArcsFrom()
                      throws XBRLException

Returns:

Get the list of arcs that are from the arc end. The list is empty if there are no arcs from the arc end.

Throws:

XBRLException

getArcsTo

List<Arc> getArcsTo()
                    throws XBRLException

Returns:

Get the list of arcs that are to the arc end. The list is empty if there are no arcs to the arc end.

Throws:

XBRLException

getArcsFromWithArcrole

List<Arc> getArcsFromWithArcrole(URI arcrole)
                                 throws XBRLException

Parameters:

arcrole - the required arcrole.

Returns:

Get the list of arcs with the given arcrole that are from the arc end. The list is empty if there are no matching arcs.

Throws:

XBRLException

getArcsToWithArcrole

List<Arc> getArcsToWithArcrole(URI arcrole)
                               throws XBRLException

Parameters:

arcrole - the required arcrole.

Returns:

Get the list of arcs with the given arcrole that are to the arc end. The list is empty if there are no matching arcs.

Throws:

XBRLException