org.xbrlapi

Interface Title

All Superinterfaces:

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

All Known Implementing Classes:

TitleImpl

public interface Title
extends Xlink

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLanguage() Get the documentation language code.
java.lang.String	getValue() Get the documentation text, with the leading and trailing spaces trimmed off.

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

Method Detail

getValue

java.lang.String getValue()
                          throws XBRLException

Get the documentation text, with the leading and trailing spaces trimmed off.

Returns:

the documentation text, with the leading and trailing spaces trimmed off.

Throws:

XBRLException

getLanguage

java.lang.String getLanguage()
                             throws XBRLException

Get the documentation language code.

Specified by:

getLanguage in interface Fragment

Returns:

the string value of the XML language attribute on the XLink title element or null if none is available.

Throws:

XBRLException