org.xbrlapi
Interface ReferencePart

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Implementing Classes:

ReferencePartImpl

public interface ReferencePart
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

ReferencePartDeclaration	getDeclaration() Currently implemented by a brute force search of the reference part declarations with the given local name.
String	getValue() Get the value of the reference part.

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

Method Detail

getValue

String getValue()
                throws XBRLException

Get the value of the reference part.

Returns:

The value of the reference part with spaces trimmed from the front and end.

Throws:

XBRLException

getDeclaration

ReferencePartDeclaration getDeclaration()
                                        throws XBRLException

Currently implemented by a brute force search of the reference part declarations with the given local name.

Returns:

an XML Schema declaration of the reference part. If more than one such declaration is in the data store then the declaration returned is application dependent.

Throws:

XBRLException - if no declarations can be found in the data store.