org.xbrlapi.xdt.aspects
Class TypedDimensionAspect

java.lang.Object
  org.xbrlapi.aspects.AspectImpl
      org.xbrlapi.xdt.aspects.DimensionAspect
          org.xbrlapi.xdt.aspects.TypedDimensionAspect

All Implemented Interfaces:

Serializable, Aspect

public class TypedDimensionAspect
extends DimensionAspect
implements Aspect

Typed dimension aspect details

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.aspects.AspectImpl

domain

Constructor Summary

TypedDimensionAspect(Domain domain, URI dimensionNamespace, String dimensionLocalname)

Method Summary

TypedDimensionAspectValue	getMissingValue()
TypedDimensionAspectValue	getValue(Context context)
TypedDimensionAspectValue	getValue(Element child)
TypedDimensionAspectValue	getValue(Fact fact)
TypedDimensionAspectValue	getValue(OpenContextComponent occ)

Methods inherited from class org.xbrlapi.xdt.aspects.DimensionAspect

getDimensionLocalname, getDimensionNamespace, getId, isExtensible

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue

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, getId, getValue, isExtensible

Constructor Detail

TypedDimensionAspect

public TypedDimensionAspect(Domain domain,
                            URI dimensionNamespace,
                            String dimensionLocalname)
                     throws XBRLException

Parameters:

domain - The domain for this aspect.

dimensionNamespace - The namespace of the dimension.

dimensionLocalname - The local name of the dimension.

Throws:

XBRLException - if the ID parameter is null.

Method Detail

getValue

public TypedDimensionAspectValue 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 TypedDimensionAspectValue getValue(Context context)
                                   throws XBRLException

Specified by:

getValue in interface Aspect

Overrides:

getValue in class AspectImpl

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

See Also:

Aspect.getValue(Context)

getValue

public TypedDimensionAspectValue getValue(OpenContextComponent occ)
                                   throws XBRLException

Throws:

XBRLException

getValue

public TypedDimensionAspectValue getValue(Element child)
                                   throws XBRLException

Throws:

XBRLException

getMissingValue

public TypedDimensionAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()