org.xbrlapi
Interface Resource

All Superinterfaces:

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

All Known Subinterfaces:

EntityResource, FootnoteResource, LabelResource, MeasureResource, MixedContentResource, ReferenceResource

All Known Implementing Classes:

EntityResourceImpl, FootnoteResourceImpl, LabelResourceImpl, MeasureResourceImpl, MixedContentResourceImpl, ReferenceResourceImpl, ResourceImpl

public interface Resource
extends ArcEnd

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

URI	getResourceRole() Get the value of the resource role (xlink:role attribute) for the resource.

Methods inherited from interface org.xbrlapi.ArcEnd

getArcEndId, getArcsFrom, getArcsFromWithArcrole, getArcsTo, getArcsToWithArcrole, getLabel, getRole

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, 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

getResourceRole

URI getResourceRole()
                    throws XBRLException

Get the value of the resource role (xlink:role attribute) for the resource.

Returns:

the value of the resource role (xlink:role attribute) for the resource or null if none is specified.

Throws:

XBRLException.

XBRLException