org.xbrlapi.impl

Class ResourceImpl

java.lang.Object

org.xbrlapi.impl.XMLImpl

org.xbrlapi.impl.FragmentImpl

org.xbrlapi.impl.ExtendedLinkContentImpl

org.xbrlapi.impl.ArcEndImpl

org.xbrlapi.impl.ResourceImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XML>, ArcEnd, ExtendedLinkContent, Fragment, Resource, Xlink, XML

Direct Known Subclasses:

MixedContentResourceImpl

public class ResourceImpl
extends ArcEndImpl
implements Resource

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
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	getResourceRole() Get the value of the resource role (xlink:role attribute) for the resource.
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).

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, 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

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

ResourceImpl

public ResourceImpl()

Method Detail

getResourceRole

public java.lang.String getResourceRole()
                                 throws XBRLException

Description copied from interface: Resource

Get the value of the resource role (xlink:role attribute) for the resource.

Specified by:

getResourceRole in interface Resource

Returns:

the value of the resource role (xlink:role attribute) for the resource or null if none is specified.

Throws:

XBRLException

See Also:

Resource.getResourceRole()

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 java.lang.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 java.lang.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 java.util.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 java.lang.String getAttribute(java.lang.String namespace,
                            java.lang.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(String, String)

getAttribute

public java.lang.String getAttribute(java.lang.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)