org.xbrlapi

Interface AspectValuePair

All Superinterfaces:

java.lang.Comparable<XML>, NonFragmentXML, java.io.Serializable, XML

All Known Implementing Classes:

AspectValuePairImpl

public interface AspectValuePair
extends NonFragmentXML

This XML Resource captures:

• The index of the XML fragment that defines the aspect value recorded in the resource
• the aspect ID and
• the aspect value ID

The XML fragment can be a fact, a context or a unit.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAspectId()
java.lang.String	getAspectValueId()
Fragment	getFragment()
java.lang.String	getFragmentIndex()
java.lang.String	getFragmentType()

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

getFragmentIndex

java.lang.String getFragmentIndex()
                                  throws XBRLException

Returns:

the XML fragment index

Throws:

XBRLException

getFragmentType

java.lang.String getFragmentType()
                                 throws XBRLException

Returns:

the XML fragment type

Throws:

XBRLException

getFragment

Fragment getFragment()
                     throws XBRLException

Returns:

the XML fragment defining this set of aspect values

Throws:

XBRLException

getAspectId

java.lang.String getAspectId()
                             throws XBRLException

Returns:

the value of the aspect ID.

Throws:

XBRLException

getAspectValueId

java.lang.String getAspectValueId()
                                  throws XBRLException

Returns:

the value of the aspect, for the XML fragment.

Throws:

XBRLException