org.xbrlapi
Interface Relationship

All Superinterfaces:

Comparable<XML>, NonFragmentXML, Serializable, XML

All Known Implementing Classes:

RelationshipImpl

public interface Relationship
extends NonFragmentXML

This XML resource supports capture of active relationship information directly in the data store. This can facilitate faster relationship analysis.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Arc	getArc()
String	getArcAttributeValue(String name) Use this method if the attribute on the arc does not have its own namespace.
String	getArcAttributeValue(URI namespace, String name) Use this method if the attribute on the arc has its own namespace.
String	getArcIndex()
String	getArcName()
URI	getArcNamespace()
Double	getArcOrder()
Integer	getArcPriority()
URI	getArcrole()
URI	getArcURI()
ExtendedLink	getExtendedLink()
String	getLinkIndex()
String	getLinkName()
URI	getLinkNamespace()
URI	getLinkRole()
String	getSignature()
<F extends Fragment> F	getSource()
String	getSourceIndex()
String	getSourceLanguageCode()
String	getSourceName()
URI	getSourceNamespace()
URI	getSourceRole()
String	getSourceType()
URI	getSourceURI()
<F extends Fragment> F	getTarget()
String	getTargetIndex()
String	getTargetLanguageCode()
String	getTargetName()
URI	getTargetNamespace()
URI	getTargetRole()
String	getTargetType()
URI	getTargetURI()
String	getUse()
boolean	isFromRoot()
boolean	isProhibiting()
boolean	isToLabel()
boolean	isToReference()
String	toString()

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

getSourceIndex

String getSourceIndex()

Returns:

the fragment index for the source of the relationship.

getTargetIndex

String getTargetIndex()

Returns:

the fragment index for the target of the relationship.

getSource

<F extends Fragment> F getSource()
                             throws XBRLException

Returns:

the source fragment of the relationship.

Throws:

XBRLException

getSourceURI

URI getSourceURI()
                 throws XBRLException

Returns:

the URI of the document containing the source of the relationship.

Throws:

XBRLException - if the URI is malformed or if the relationship has not been initialised with the source URI.

getTargetURI

URI getTargetURI()
                 throws XBRLException

Returns:

the URI of the document containing the target of the relationship.

Throws:

XBRLException - if the URI is malformed or if the relationship has not been initialised with the target URI.

getTarget

<F extends Fragment> F getTarget()
                             throws XBRLException

Returns:

the target fragment of the relationship.

Throws:

XBRLException

getLinkRole

URI getLinkRole()

Returns:

the XLink link role of the relationship.

getArcrole

URI getArcrole()

Returns:

the XLink arcrole of the relationship.

getArcOrder

Double getArcOrder()

Returns:

the XLink arc order for the relationship.

getArcPriority

Integer getArcPriority()

Returns:

the arc priority for the relationship.

getUse

String getUse()

Returns:

the arc use for the relationship.

isProhibiting

boolean isProhibiting()
                      throws XBRLException

Returns:

true if the relationship has prohibited use and false otherwise. Note that this does not test if this relationship is prohibited by another relationship with a higher priority.

Throws:

XBRLException

getArcAttributeValue

String getArcAttributeValue(URI namespace,
                            String name)
                            throws XBRLException

Use this method if the attribute on the arc has its own namespace.

Parameters:

namespace - The namespace of the attribute.

name - The local name of the attribute.

Returns:

The value of the attribute on the arc or null if no such attribute exists.

Throws:

XBRLException

getArcAttributeValue

String getArcAttributeValue(String name)
                            throws XBRLException

Use this method if the attribute on the arc does not have its own namespace.

Parameters:

name - The name of the attribute.

Returns:

The value of the attribute on the arc or null if no such attribute exists.

Throws:

XBRLException

getSourceNamespace

URI getSourceNamespace()

Returns:

the source element namespace.

getTargetNamespace

URI getTargetNamespace()

Returns:

the target element namespace.

getArcNamespace

URI getArcNamespace()

Returns:

the arc element namespace.

getLinkNamespace

URI getLinkNamespace()

Returns:

the link element namespace.

getArc

Arc getArc()
           throws XBRLException

Returns:

the arc fragment defining the relationship.

Throws:

XBRLException

getArcIndex

String getArcIndex()

Returns:

the arc fragment index.

getArcURI

URI getArcURI()
              throws XBRLException

Returns:

the URI of the document containing the arc defining this persisted relationship.

Throws:

XBRLException - if the URI is malformed

getSourceName

String getSourceName()

Returns:

the source element name.

getTargetName

String getTargetName()

Returns:

the target element name.

getArcName

String getArcName()

Returns:

the arc element name.

getLinkIndex

String getLinkIndex()
                    throws XBRLException

Returns:

the index of the containing extended link.

Throws:

XBRLException

getExtendedLink

ExtendedLink getExtendedLink()
                             throws XBRLException

Returns:

the extended link that contains the arc defining the relationship.

Throws:

XBRLException

getLinkName

String getLinkName()

Returns:

the link element name.

getSourceRole

URI getSourceRole()

Returns:

the source XLink role or null if none exists.

getTargetRole

URI getTargetRole()

Returns:

the target XLink role or null if none exists.

getSignature

String getSignature()

Returns:

the relationship signature which is what is used to match up relationships that override or prohibit one another.

getSourceLanguageCode

String getSourceLanguageCode()

Returns:

the source XML language code or null if none exists.

getTargetLanguageCode

String getTargetLanguageCode()

Returns:

the target XML language code or null if none exists.

getSourceType

String getSourceType()

Returns:

the type of the source fragment.

getTargetType

String getTargetType()

Returns:

the type of the target fragment.

isToLabel

boolean isToLabel()

Returns:

true if the relationship is to an XBRL 2.1 or generic label

isToReference

boolean isToReference()

Returns:

true if the relationship is to an XBRL 2.1 or generic reference

isFromRoot

boolean isFromRoot()
                   throws XBRLException

Returns:

true if the relationship is from a source fragment that is not also a target fragment in the same network of relationships that this relationship participates in. Returns false otherwise.

Throws:

XBRLException

toString

String toString()

Overrides:

toString in class Object

Returns:

the string expression of the relationship as a sequence of fragment indices source:arc:target.