org.xbrlapi.impl
Class ArcEndImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LocatorImpl, ResourceImpl

public class ArcEndImpl
extends ExtendedLinkContentImpl
implements ArcEnd

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

ArcEndImpl()

Method Summary

String	getArcEndId() Get the id attribute value.
List<Arc>	getArcsFrom()
List<Arc>	getArcsFromWithArcrole(URI arcrole)
List<Arc>	getArcsTo() Get the list of arcs that are to the arc end.
List<Arc>	getArcsToWithArcrole(URI arcrole)
String	getAttribute(String name) Get a no-namespace attribute value.
String	getAttribute(URI namespace, String localname) Get a non-xlink attribute value.
String	getLabel() Get the xlink:label attribute value.
String	getRole() Get the xlink:role attribute value.
protected URI	getTargetDocumentURI(URI uri) Get the URI of the document containing the fragment targetted by the supplied URI.
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 specific title fragment
List<Title>	getTitleElements() Get a list of titles (The xlink:title children elements).
String	getXlinkType() Get the xlink type (The xxlink:type attribute value).

Methods inherited from class org.xbrlapi.impl.ExtendedLinkContentImpl

getExtendedLink

Methods inherited from class org.xbrlapi.impl.FragmentImpl

appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, 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, 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.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, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, 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, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

ArcEndImpl

public ArcEndImpl()

Method Detail

getLabel

public String getLabel()
                throws XBRLException

Get the xlink:label attribute value.

Specified by:

getLabel in interface ArcEnd

Returns:

the xlink:label attribute value.

Throws:

XBRLException - if the xlink:label attribute does not exist.

See Also:

ArcEnd.getLabel()

getRole

public String getRole()
               throws XBRLException

Get the xlink:role attribute value.

Specified by:

getRole in interface ArcEnd

Returns:

the value of the id attribute or null if no such attribute exists.

Throws:

XBRLException

See Also:

ArcEnd.getRole()

getArcsFrom

public List<Arc> getArcsFrom()
                      throws XBRLException

Specified by:

getArcsFrom in interface ArcEnd

Returns:

Get the list of arcs that are from the arc end. The list is empty if there are no arcs from the arc end.

Throws:

XBRLException

See Also:

ArcEnd.getArcsFrom()

getArcsFromWithArcrole

public List<Arc> getArcsFromWithArcrole(URI arcrole)
                                 throws XBRLException

Specified by:

getArcsFromWithArcrole in interface ArcEnd

Parameters:

arcrole - the required arcrole.

Returns:

Get the list of arcs with the given arcrole that are from the arc end. The list is empty if there are no matching arcs.

Throws:

XBRLException

See Also:

ArcEnd.getArcsFromWithArcrole(URI)

getArcsToWithArcrole

public List<Arc> getArcsToWithArcrole(URI arcrole)
                               throws XBRLException

Specified by:

getArcsToWithArcrole in interface ArcEnd

Parameters:

arcrole - the required arcrole.

Returns:

Get the list of arcs with the given arcrole that are to the arc end. The list is empty if there are no matching arcs.

Throws:

XBRLException

See Also:

ArcEnd.getArcsToWithArcrole(URI)

getArcsTo

public List<Arc> getArcsTo()
                    throws XBRLException

Get the list of arcs that are to the arc end.

Specified by:

getArcsTo in interface ArcEnd

Returns:

the list of arcs to the arc end. The list is empty if there are no arcs to the arc end.

Throws:

XBRLException

See Also:

ArcEnd.getArcsTo()

getArcEndId

public String getArcEndId()
                   throws XBRLException

Get the id attribute value.

Specified by:

getArcEndId in interface ArcEnd

Returns:

the value of the id attribute or null if no such attribute exists.

Throws:

XBRLException

See Also:

ArcEnd.getArcEndId()

getXlinkType

public String getXlinkType()
                    throws XBRLException

Get the xlink type (The xxlink:type attribute value).

Specified by:

getXlinkType in interface Xlink

Returns:

the value of the xlink:type attribute.

Throws:

XBRLException

See Also:

Xlink.getXlinkType()

getTitleAttribute

public String getTitleAttribute()
                         throws XBRLException

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

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

Get a specific title fragment

Specified by:

getTitleElement in interface Xlink

Parameters:

index - The index of the required title element

Returns:

the title fragment or null if there are no title children elements.

Throws:

XBRLException - if the index is out of bounds

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 targetted by the supplied URI.

Parameters:

uri - The supplied URI for decomposition.

Returns:

The URI of the the document containing the fragment targetted 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