public class LocatorImpl extends ArcEndImpl implements Locator
Constructor and Description |
---|
LocatorImpl() |
Modifier and Type | Method and Description |
---|---|
java.net.URI |
getAbsoluteHref()
Get the absolute value of the HREF to the metadata.
|
java.lang.String |
getAttribute(java.lang.String name)
Get a no-namespace attribute value.
|
java.lang.String |
getAttribute(java.lang.String namespace,
java.lang.String localname)
Get a non-xlink attribute value.
|
ExtendedLink |
getExtendedLink()
Get the extended link containing the extended link xlink content.
|
java.lang.String |
getHref()
Get the raw xlink:href attribute value (before any resolution).
|
Fragment |
getTarget() |
java.net.URI |
getTargetDocumentURI() |
java.lang.String |
getTargetPointerValue() |
java.lang.String |
getTitleAttribute()
Get the title (The xlink:title attribute value).
|
Title |
getTitleElement(int index)
Get a list of titles (The xlink:title children elements).
|
java.util.List<Title> |
getTitleElements()
Get a list of titles (The xlink:title children elements).
|
java.lang.String |
getXlinkType()
Get the xlink type (The xxlink:type attribute value).
|
void |
setTarget(java.net.URI uri)
Set metadata about the target of the locator.
|
getArcEndId, getArcsFrom, getArcsFromWithArcrole, getArcsTo, getArcsToWithArcrole, getLabel, getRole
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
appendMetadataElement, compareTo, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore
getClass, notify, notifyAll, toString, wait, wait, wait
getArcEndId, getArcsFrom, getArcsFromWithArcrole, getArcsTo, getArcsToWithArcrole, getLabel, getRole
getAttribute, getAttribute, getTitleAttribute, getTitleElement, getTitleElements, getXlinkType
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
appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore
public void setTarget(java.net.URI uri) throws XBRLException
Locator
setTarget
in interface Locator
XBRLException
Locator.setTarget(URI)
public java.lang.String getHref() throws XBRLException
getHref
in interface Locator
XBRLException
- if the attribute is missing.Locator.getHref()
public java.net.URI getAbsoluteHref() throws XBRLException
getAbsoluteHref
in interface Locator
XBRLException.
XBRLException
Locator.getAbsoluteHref()
public java.net.URI getTargetDocumentURI() throws XBRLException
getTargetDocumentURI
in interface Locator
XBRLException
Locator.getTargetDocumentURI()
public java.lang.String getTargetPointerValue() throws XBRLException
getTargetPointerValue
in interface Locator
XBRLException
Locator.getTargetPointerValue()
public Fragment getTarget() throws XBRLException
getTarget
in interface Locator
XBRLException
- if the locator does not reference exactly one fragment.Locator.getTarget()
public ExtendedLink getExtendedLink() throws XBRLException
ExtendedLinkContent
getExtendedLink
in interface ExtendedLinkContent
getExtendedLink
in class ExtendedLinkContentImpl
XBRLException
ExtendedLinkContent.getExtendedLink()
public java.lang.String getXlinkType() throws XBRLException
Xlink
getXlinkType
in interface Xlink
XBRLException
Xlink.getXlinkType()
public java.lang.String getTitleAttribute() throws XBRLException
Xlink
getTitleAttribute
in interface Xlink
XBRLException
Xlink.getTitleAttribute()
public java.util.List<Title> getTitleElements() throws XBRLException
Xlink
getTitleElements
in interface Xlink
XBRLException
Xlink.getTitleElements()
public Title getTitleElement(int index) throws XBRLException
Xlink
getTitleElement
in interface Xlink
index
- The index of the required title elementXBRLException
Xlink.getTitleElement(int)
public java.lang.String getAttribute(java.lang.String namespace, java.lang.String localname) throws XBRLException
Xlink
getAttribute
in interface Xlink
namespace
- The namespace of the attribute to retrievelocalname
- The local name of the attribute to retrieveXBRLException
- if the namespace URI is for the XLink namespace.Xlink.getAttribute(String, String)
public java.lang.String getAttribute(java.lang.String name) throws XBRLException
Xlink
getAttribute
in interface Xlink
name
- The name of the no-namespace attribute to retrieveXBRLException
Xlink.getAttribute(String)