XBRLAPI

A Java API for XBRL


org.xbrlapi.aspects
Interface Aspect

All Superinterfaces:
Serializable
All Known Implementing Classes:
AspectImpl, ConceptAspect, DimensionAspect, EntityAspect, ExplicitDimensionAspect, LocationAspect, PeriodAspect, ScenarioAspect, ScenarioRemainderAspect, SegmentAspect, SegmentRemainderAspect, TupleAspect, TypedDimensionAspect, UnitAspect

public interface Aspect
extends Serializable

Aspect explanation.

An aspect is a characteristic of XBRL facts. Not all XBRL facts need to define a value for an aspect. For example, non-numeric facts do not define values for the aspect that captures measurement units.

Aspects have the following characteristics:

Author:
Geoff Shuetrim (geoff@galexy.net)

Method Summary
 Domain getDomain()
           
 URI getId()
           
 AspectValue getMissingValue()
           
 AspectValue getValue(Context context)
           
 AspectValue getValue(Fact fact)
           
 AspectValue getValue(Unit unit)
           
 boolean isExtensible()
           
 

Method Detail

getValue

AspectValue getValue(Fact fact)
                     throws XBRLException
Parameters:
fact - The fact to get the aspect value for.
Returns:
a value for this aspect for the given fact.
Throws:
XBRLException

getValue

AspectValue getValue(Context context)
                     throws XBRLException
Parameters:
context - The context to get the aspect value from.
Returns:
the aspect value for the context or the missing aspect value if the context does not define a value for the aspect.
Throws:
XBRLException

getValue

AspectValue getValue(Unit unit)
                     throws XBRLException
Parameters:
unit - The unit to get the aspect value from.
Returns:
the aspect value for the context or the missing aspect value if the unit does not define a value for the aspect.
Throws:
XBRLException

getDomain

Domain getDomain()
Returns:
The domain of valid values for this aspect.

getId

URI getId()
Returns:
the URI that identifies this aspect.

getMissingValue

AspectValue getMissingValue()
Returns:
the missing aspect value for this aspect.

isExtensible

boolean isExtensible()
Returns:
true if the aspect can be defined by DTS augmentations and false otherwise. True for XDT dimensions, for example, and false for concept and location aspects, for example.

Get Java XBRL API implementation at SourceForge.net.