org.xbrlapi
Interface AspectValuePair

All Superinterfaces:

Comparable<XML>, NonFragmentXML, 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

URI	getAspectId()
String	getAspectValueId()
Fragment	getFragment()
String	getFragmentIndex()
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

String getFragmentIndex()
                        throws XBRLException

Returns:

the XML fragment index

Throws:

XBRLException

getFragmentType

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

URI getAspectId()
                throws XBRLException

Returns:

the value of the aspect ID.

Throws:

XBRLException

getAspectValueId

String getAspectValueId()
                        throws XBRLException

Returns:

the value of the aspect, for the XML fragment.

Throws:

XBRLException