org.xbrlapi
Interface Xlink

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Subinterfaces:

Arc, ArcEnd, EntityResource, ExtendedLink, ExtendedLinkContent, FootnoteResource, LabelResource, Link, Locator, MeasureResource, MixedContentResource, ReferenceResource, Resource, SimpleLink, Title

All Known Implementing Classes:

ArcEndImpl, ArcImpl, EntityResourceImpl, ExtendedLinkContentImpl, ExtendedLinkImpl, FootnoteResourceImpl, LabelResourceImpl, LinkImpl, LocatorImpl, MeasureResourceImpl, MixedContentResourceImpl, ReferenceResourceImpl, ResourceImpl, SimpleLinkImpl, TitleImpl, TypedDimensionImpl

public interface Xlink
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getAttribute(String name) Get a no-namespace attribute value.
String	getAttribute(URI namespace, String localname) Get a non-xlink attribute value.
String	getTitleAttribute() Get the title (The xlink:title attribute value).
Title	getTitleElement(int index) Get a list of titles (The xlink:title children elements).
List<Title>	getTitleElements() Get a list of titles (The xlink:title children elements).
String	getXlinkType() Get the xlink type (The xxlink:type attribute value).

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

getXlinkType

String getXlinkType()
                    throws XBRLException

Get the xlink type (The xxlink:type attribute value). This is one of simple or extended

Throws:

XBRLException

getTitleAttribute

String getTitleAttribute()
                         throws XBRLException

Get the title (The xlink:title attribute value).

Returns:

the value of the xlink:title attribute or null if none is supplied.

Throws:

XBRLException

getTitleElements

List<Title> getTitleElements()
                             throws XBRLException

Get a list of titles (The xlink:title children elements).

Returns:

a fragment list of title elements or null if there are none.

Throws:

XBRLException

getTitleElement

Title getTitleElement(int index)
                      throws XBRLException

Get a list of titles (The xlink:title children elements). Returns null if there are no title children elements.

Parameters:

index - The index of the required title element

Returns:

The specified title fragment

Throws:

XBRLException

getAttribute

String getAttribute(URI namespace,
                    String localname)
                    throws XBRLException

Get a non-xlink attribute value.

Parameters:

namespace - The namespace of the attribute to retrieve

localname - The local name of the attribute to retrieve

Throws:

XBRLException - if the namespace URI is for the XLink namespace.

getAttribute

String getAttribute(String name)
                    throws XBRLException

Get a no-namespace attribute value.

Parameters:

name - The name of the no-namespace attribute to retrieve

Throws:

XBRLException