org.xbrlapi.aspects
Class UnitAspect

java.lang.Object
  org.xbrlapi.aspects.AspectImpl
      org.xbrlapi.aspects.UnitAspect

All Implemented Interfaces:

Serializable, Aspect

public class UnitAspect
extends AspectImpl
implements Aspect

Unit aspect details

Captures XBRL instance unit value information.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

static URI

ID The URI uniquely identifying this concept aspect.

Fields inherited from class org.xbrlapi.aspects.AspectImpl

domain

Constructor Summary

UnitAspect(Domain domain)

Method Summary

URI	getId()
UnitAspectValue	getMissingValue()
UnitAspectValue	getValue(Fact fact)
UnitAspectValue	getValue(Unit unit)

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue, isExtensible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xbrlapi.aspects.Aspect

getDomain, getValue, isExtensible

Field Detail

ID

public static URI ID

The URI uniquely identifying this concept aspect.

Constructor Detail

UnitAspect

public UnitAspect(Domain domain)
           throws XBRLException

Parameters:

domain - The domain for this aspect.

Throws:

XBRLException

Method Detail

getId

public URI getId()

Specified by:

getId in interface Aspect

Returns:

the URI that identifies this aspect.

See Also:

Aspect.getId()

getValue

public UnitAspectValue getValue(Fact fact)
                         throws XBRLException

Specified by:

getValue in interface Aspect

Parameters:

fact - The fact to get the aspect value for.

Returns:

a value for this aspect for the given fact.

Throws:

XBRLException

See Also:

Aspect.getValue(Fact)

getValue

public UnitAspectValue getValue(Unit unit)
                         throws XBRLException

Specified by:

getValue in interface Aspect

Overrides:

getValue in class AspectImpl

Parameters:

unit - The unit to capture the unit aspect value from

Returns:

the unit aspect value.

Throws:

XBRLException

See Also:

Aspect.getValue(Unit)

getMissingValue

public UnitAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()