org.xbrlapi
Interface ReferenceResource

All Superinterfaces:

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

All Known Implementing Classes:

ReferenceResourceImpl

public interface ReferenceResource
extends MixedContentResource

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

ReferencePart	getReferencePart(URI namespace, String localname) Get a specific reference part from a reference.
List<ReferencePart>	getReferenceParts() Get a list of reference part fragments.

Methods inherited from interface org.xbrlapi.MixedContentResource

getContentAsNodeList, getContentAsXHTMLString

Methods inherited from interface org.xbrlapi.Resource

getResourceRole

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

getReferenceParts

List<ReferencePart> getReferenceParts()
                                      throws XBRLException

Get a list of reference part fragments.

Returns:

the list of reference part fragments that are children of the reference.

Throws:

XBRLException

getReferencePart

ReferencePart getReferencePart(URI namespace,
                               String localname)
                               throws XBRLException

Get a specific reference part from a reference. Returns null if no such reference part exists.

Parameters:

namespace - The namespace in which the reference part has been defined

localname - The local name of the reference part

Throws:

XBRLException