org.xbrlapi
Interface SimpleLink

All Superinterfaces:

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

All Known Implementing Classes:

SimpleLinkImpl, TypedDimensionImpl

public interface SimpleLink
extends Link

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

URI	getAbsoluteHref() Get the absolute value of the HREF to the metadata.
URI	getArcrole() Get the link arcrole attribute value, before any resolution.
String	getHref() Get the link HREF attribute value, before any resolution.
Fragment	getTarget()
URI	getTargetDocumentURI()
void	setTarget(URI uri) Set metadata about the target of the simple link.

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

setTarget

void setTarget(URI uri)
               throws XBRLException

Set metadata about the target of the simple link. This includes, the absolute URI, the target document URI and the XPointer value used to identify part of the target document.

Throws:

XBRLException

getHref

String getHref()
               throws XBRLException

Get the link HREF attribute value, before any resolution.

Throws:

XBRLException

getArcrole

URI getArcrole()
               throws XBRLException

Get the link arcrole attribute value, before any resolution.

Throws:

XBRLException

getTarget

Fragment getTarget()
                   throws XBRLException

Returns:

the single fragment referenced by the simple link null if none is found.

Throws:

XBRLException

getAbsoluteHref

URI getAbsoluteHref()
                    throws XBRLException

Get the absolute value of the HREF to the metadata.

Returns:

The absolute URI specified by the locator HREF attribute. This includes the query and fragment parts of the URI (if there are any) and has NOT been adjusted to reflect any URI matching features. of the data store.

Throws:

XBRLException.

XBRLException

getTargetDocumentURI

URI getTargetDocumentURI()
                         throws XBRLException

Returns:

the document URI for the target fragment. This omits the query and fragment parts of the URI and has been adjusted to reflect any URI matching features of the data store.

Throws:

XBRLException.

XBRLException