org.xbrlapi
Interface Locator
- All Superinterfaces:
- ArcEnd, Comparable<XML>, ExtendedLinkContent, Fragment, Serializable, Xlink, XML
- All Known Implementing Classes:
- LocatorImpl
public interface Locator
- extends ArcEnd
- Author:
- Geoffrey Shuetrim (geoff@galexy.net)
| 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 |
setTarget
void setTarget(URI uri)
throws XBRLException
- Set metadata about the target of the locator.
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 raw xlink:href attribute value (before any resolution).
- Returns:
- the value of the xlink:href attribute on the locator.
- Throws:
XBRLException - if the attribute is missing.
getTarget
Fragment getTarget()
throws XBRLException
- Returns:
- the single fragment referenced by the locator or none if none
is found.
- Throws:
XBRLException - if the locator does not reference exactly one fragment.
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.
- Throws:
XBRLException.
XBRLException
getTargetDocumentURI
URI getTargetDocumentURI()
throws XBRLException
- Returns:
- the document URI for the target fragment.
- Throws:
XBRLException.
XBRLException
getTargetPointerValue
String getTargetPointerValue()
throws XBRLException
- Returns:
- the string value of the XPointer element scheme expression from the xlink:href attribute.
- Throws:
XBRLException.
XBRLException