org.xbrlapi.aspects

Class UnitAspectValue

java.lang.Object

org.xbrlapi.aspects.AspectValueImpl

org.xbrlapi.aspects.UnitAspectValue

All Implemented Interfaces:

java.io.Serializable, AspectHandler, AspectValue

public class UnitAspectValue
extends AspectValueImpl
implements AspectValue

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnitAspectValue() Missing aspect value constructor.
UnitAspectValue(Unit unit)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAspectId()
java.util.List<Measure>	getDenominators()
java.lang.String	getId() The missing aspect value ID is the empty string.
java.util.List<Measure>	getNumerators()
boolean	hasDenominators()
boolean	isMissing() This method must be implemented by each concrete aspect value class.

Methods inherited from class org.xbrlapi.aspects.AspectValueImpl

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnitAspectValue

public UnitAspectValue()

Missing aspect value constructor.

UnitAspectValue

public UnitAspectValue(Unit unit)
                throws XBRLException

Parameters:

unit - The unit fragment.

Throws:

XBRLException

Method Detail

getNumerators

public java.util.List<Measure> getNumerators()

getDenominators

public java.util.List<Measure> getDenominators()

hasDenominators

public boolean hasDenominators()

getAspectId

public java.lang.String getAspectId()

Specified by:

getAspectId in interface AspectHandler

Returns:

the aspect itself

See Also:

AspectHandler.getAspectId()

isMissing

public boolean isMissing()

Description copied from interface: AspectValue

This method must be implemented by each concrete aspect value class.

Specified by:

isMissing in interface AspectValue

Returns:

true if this aspect value represents a missing value and false otherwise.

See Also:

AspectValue.isMissing()

getId

public java.lang.String getId()

The missing aspect value ID is the empty string.

Specified by:

getId in interface AspectValue

Returns:

the string value that uniquely identifies this aspect value, for a given aspect. This value is not generally human readable. The label handler methods are more suitable for obtaining human readable representations of aspect values. A unique value for missing aspect values needs to be generated by implementations of this method.

See Also:

AspectValue.getId()