org.xbrlapi.impl
Class LocatorImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.FragmentImpl
          org.xbrlapi.impl.ExtendedLinkContentImpl
              org.xbrlapi.impl.ArcEndImpl
                  org.xbrlapi.impl.LocatorImpl

All Implemented Interfaces:

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

public class LocatorImpl
extends ArcEndImpl
implements Locator

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

LocatorImpl()

Method Summary

URI	getAbsoluteHref() Get the absolute value of the HREF to the metadata.
String	getAttribute(String name) Get a no-namespace attribute value.
String	getAttribute(URI namespace, String localname) Get a non-xlink attribute value.
ExtendedLink	getExtendedLink() Get the extended link containing the extended link xlink content.
String	getHref() Get the raw xlink:href attribute value (before any resolution).
Fragment	getTarget()
URI	getTargetDocumentURI()
protected URI	getTargetDocumentURI(URI uri) Get the URI of the document containing the fragment targeted by the supplied URI.
String	getTargetPointerValue()
protected String	getTargetPointerValue(String pointer) Get the value of the XPointer that corresponds to the XPointer information stored in the metadata of all fragments.
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).
void	setTarget(URI uri) Set metadata about the target of the locator.

Methods inherited from class org.xbrlapi.impl.ArcEndImpl

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

Methods inherited from class org.xbrlapi.impl.FragmentImpl

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 class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, equals, finalize, 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 class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xbrlapi.ArcEnd

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

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

Constructor Detail

LocatorImpl

public LocatorImpl()

Method Detail

setTarget

public void setTarget(URI uri)
               throws XBRLException

Description copied from interface: Locator

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.

Specified by:

setTarget in interface Locator

Throws:

XBRLException

See Also:

Locator.setTarget(URI)

getHref

public String getHref()
               throws XBRLException

Get the raw xlink:href attribute value (before any resolution).

Specified by:

getHref in interface Locator

Returns:

the value of the xlink:href attribute on the locator.

Throws:

XBRLException - if the attribute is missing.

See Also:

Locator.getHref()

getAbsoluteHref

public URI getAbsoluteHref()
                    throws XBRLException

Get the absolute value of the HREF to the metadata.

Specified by:

getAbsoluteHref in interface Locator

Returns:

The absolute URI specified by the locator HREF attribute.

Throws:

XBRLException.

XBRLException

See Also:

Locator.getAbsoluteHref()

getTargetDocumentURI

public URI getTargetDocumentURI()
                         throws XBRLException

Specified by:

getTargetDocumentURI in interface Locator

Returns:

the document URI for the target fragment.

Throws:

XBRLException

See Also:

Locator.getTargetDocumentURI()

getTargetPointerValue

public String getTargetPointerValue()
                             throws XBRLException

Specified by:

getTargetPointerValue in interface Locator

Returns:

the string value of the XPointer element scheme expression from the xlink:href attribute.

Throws:

XBRLException

See Also:

Locator.getTargetPointerValue()

getTarget

public Fragment getTarget()
                   throws XBRLException

Specified by:

getTarget in interface Locator

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.

See Also:

Locator.getTarget()

getExtendedLink

public ExtendedLink getExtendedLink()
                             throws XBRLException

Description copied from interface: ExtendedLinkContent

Get the extended link containing the extended link xlink content.

Specified by:

getExtendedLink in interface ExtendedLinkContent

Overrides:

getExtendedLink in class ExtendedLinkContentImpl

Returns:

the extended link fragment containing the extended link xlink content.

Throws:

XBRLException

See Also:

ExtendedLinkContent.getExtendedLink()

getXlinkType

public String getXlinkType()
                    throws XBRLException

Description copied from interface: Xlink

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

Specified by:

getXlinkType in interface Xlink

Throws:

XBRLException

See Also:

Xlink.getXlinkType()

getTitleAttribute

public String getTitleAttribute()
                         throws XBRLException

Description copied from interface: Xlink

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

Specified by:

getTitleAttribute in interface Xlink

Returns:

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

Throws:

XBRLException

See Also:

Xlink.getTitleAttribute()

getTitleElements

public List<Title> getTitleElements()
                             throws XBRLException

Description copied from interface: Xlink

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

Specified by:

getTitleElements in interface Xlink

Returns:

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

Throws:

XBRLException

See Also:

Xlink.getTitleElements()

getTitleElement

public Title getTitleElement(int index)
                      throws XBRLException

Description copied from interface: Xlink

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

Specified by:

getTitleElement in interface Xlink

Parameters:

index - The index of the required title element

Returns:

The specified title fragment

Throws:

XBRLException

See Also:

Xlink.getTitleElement(int)

getAttribute

public String getAttribute(URI namespace,
                           String localname)
                    throws XBRLException

Description copied from interface: Xlink

Get a non-xlink attribute value.

Specified by:

getAttribute in interface Xlink

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.

See Also:

Xlink.getAttribute(URI, String)

getAttribute

public String getAttribute(String name)
                    throws XBRLException

Description copied from interface: Xlink

Get a no-namespace attribute value.

Specified by:

getAttribute in interface Xlink

Parameters:

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

Throws:

XBRLException

See Also:

Xlink.getAttribute(String)

getTargetDocumentURI

protected URI getTargetDocumentURI(URI uri)
                            throws XBRLException

Get the URI of the document containing the fragment targeted by the supplied URI.

Parameters:

uri - The supplied URI for decomposition.

Returns:

The URI of the the document containing the fragment targeted by the supplied URI.

Throws:

XBRLException

getTargetPointerValue

protected String getTargetPointerValue(String pointer)
                                throws XBRLException

Get the value of the XPointer that corresponds to the XPointer information stored in the metadata of all fragments.

Parameters:

pointer - The String value of the XPointer supplied in the URI.

Returns:

The value of the XPointer corresponding to the XPointer information stored in the metadata of all fragments. Returns the empty string if the XPointer does not specify an element scheme or ID based shorthand pointer value.

Throws:

XBRLException