org.xbrlapi
Interface Arc

All Superinterfaces:

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

All Known Implementing Classes:

ArcImpl

public interface Arc
extends ExtendedLinkContent

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getActuate() Get the xlink:actuate attribute value.
URI	getArcrole()
String	getAttribute(String name) Get a no-namespace attribute value.
String	getAttribute(URI namespace, String name) Get a non-xlink attribute value.
String	getFrom() Get the xlink:from attribute value.
Double	getOrder() Get the order attribute value.
URI	getPreferredLabelRole() This method is useful in the context of parent-child presentation relationships as defined in the XBRL 2.1 specification.
Integer	getPriority()
NamedNodeMap	getSemanticAttributes() Gets a list of the attributes that define the semantics of an arc.
String	getSemanticKey()
String	getShow() Get the xlink:show attribute value.
<E extends ArcEnd> List<E>	getSourceFragments() Get the list of ArcEnd fragments that the arc runs from.
<E extends ArcEnd> List<E>	getTargetFragments() Get the list of ArcEnd fragments that the arc runs to.
String	getTo() Get the xlink:to attribute value.
String	getUse()
Double	getWeight() This method is useful in the context of summation-item calculation relationships as defined in the XBRL 2.1 specification.
boolean	hasAttribute(String name)
boolean	hasAttribute(String namespace, String name)
boolean	isProhibited()
boolean	semanticEquals(Arc other) Returns true if this arc is semantically equal to the other arc.

Methods inherited from interface org.xbrlapi.ExtendedLinkContent

getExtendedLink

Methods inherited from interface org.xbrlapi.Xlink

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

getAttribute

String getAttribute(URI namespace,
                    String name)
                    throws XBRLException

Description copied from interface: Xlink

Get a non-xlink attribute value.

Specified by:

getAttribute in interface Xlink

Parameters:

namespace - The namespace of the attribute

name - The local name of the attribute

Returns:

the value of the attribute or null if the arc does not have the attribute.

Throws:

XBRLException

hasAttribute

boolean hasAttribute(String namespace,
                     String name)
                     throws XBRLException

Parameters:

namespace - The namespace of the attribute

name - The local name of the attribute

Returns:

true if the arc has the attribute

Throws:

XBRLException

getAttribute

String getAttribute(String name)
                    throws XBRLException

Description copied from interface: Xlink

Get a no-namespace attribute value.

Specified by:

getAttribute in interface Xlink

Parameters:

name - The name of the attribute

Returns:

the value of the attribute or null if the arc does not have the attribute.

Throws:

XBRLException

hasAttribute

boolean hasAttribute(String name)
                     throws XBRLException

Parameters:

name - The name of the attribute

Returns:

true if the arc has the attribute

Throws:

XBRLException

getShow

String getShow()
               throws XBRLException

Get the xlink:show attribute value.

Returns:

the value of the xlink:show value or null if the attribute is not there.

Throws:

XBRLException

getActuate

String getActuate()
                  throws XBRLException

Get the xlink:actuate attribute value.

Returns:

the value of the xlink:actuate value or null if the attribute is not there.

Throws:

XBRLException

getFrom

String getFrom()
               throws XBRLException

Get the xlink:from attribute value.

Returns:

the value of the xlink:from value or null if the attribute is not there.

Throws:

XBRLException

getTo

String getTo()
             throws XBRLException

Get the xlink:to attribute value.

Returns:

the value of the xlink:to value or null if the attribute is not there.

Throws:

XBRLException

getArcrole

URI getArcrole()
               throws XBRLException

Returns:

the arc role of the arc.

Throws:

XBRLException

getOrder

Double getOrder()
                throws XBRLException

Get the order attribute value.

Returns:

the value of the order attribute or default value of 1 if none is provided.

Throws:

XBRLException

getSourceFragments

<E extends ArcEnd> List<E> getSourceFragments()
                                          throws XBRLException

Get the list of ArcEnd fragments that the arc runs from.

Returns:

the list of ArcEnd fragment that the arc runs from.

Throws:

XBRLException

getTargetFragments

<E extends ArcEnd> List<E> getTargetFragments()
                                          throws XBRLException

Get the list of ArcEnd fragments that the arc runs to.

Returns:

the list of ArcEnd fragment that the arc runs to.

Throws:

XBRLException

getSemanticAttributes

NamedNodeMap getSemanticAttributes()
                                   throws XBRLException

Gets a list of the attributes that define the semantics of an arc. These are important as part of checking whether two arcs are semantically equal and so can prohibit or over-ride eachother.

Returns:

a map of attribute nodes for semantic analysis.

Throws:

XBRLException

See Also:

semanticEquals(Arc)

getSemanticKey

String getSemanticKey()
                      throws XBRLException

Returns:

A string that is only equal for semantically equal arcs. The string reflects the names and values of the semantic attributes and provides that information in a consistent order.

Throws:

XBRLException

semanticEquals

boolean semanticEquals(Arc other)
                       throws XBRLException

Returns true if this arc is semantically equal to the other arc. Semantic equality is defined such that two arcs can prohibit or override each-other only if they are semantically equal. This is a pre-requisite (but not the only) condition for prohibition and over-riding of XLink relationships.

Parameters:

other - The other arc.

Returns:

true if and only if the two arcs are semantically equal.

Throws:

XBRLException

getPriority

Integer getPriority()
                    throws XBRLException

Returns:

the relationship priority specified on the arc.

Throws:

XBRLException

getUse

String getUse()
              throws XBRLException

Returns:

the relationship use, "optional" or "prohibited", as specified on the arc.

Throws:

XBRLException

isProhibited

boolean isProhibited()
                     throws XBRLException

Returns:

true if the arc has a use attribute equal to 'prohibited' and false otherwise.

Throws:

XBRLException

getWeight

Double getWeight()
                 throws XBRLException

This method is useful in the context of summation-item calculation relationships as defined in the XBRL 2.1 specification.

Returns:

the value of the weight attribute or null if the relationship is not of the necessary type.

Throws:

XBRLException

getPreferredLabelRole

URI getPreferredLabelRole()
                          throws XBRLException

This method is useful in the context of parent-child presentation relationships as defined in the XBRL 2.1 specification.

Returns:

null if the relationship is not of the necessary type. Otherwise returns the value of the preferredLabel attribute if it is on the arc. Otherwise returns the standard label resource role Constants.StandardLabelRole

Throws:

XBRLException