org.xbrlapi.xdt.aspects
Class ExplicitDimensionAspect

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

All Implemented Interfaces:

Serializable, Aspect

public class ExplicitDimensionAspect
extends DimensionAspect
implements Aspect

Explicit 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

ExplicitDimensionAspect(Domain domain, URI dimensionNamespace, String dimensionLocalname)

Method Summary

ExplicitDimensionAspectValue	getDefaultValue(Store store) This method only determines the default value from the store on the first time.
ExplicitDimensionAspectValue	getMissingValue()
ExplicitDimensionAspectValue	getValue(Context context)
ExplicitDimensionAspectValue	getValue(Fact fact)
ExplicitDimensionAspectValue	getValue(OpenContextComponent occ)
ExplicitDimensionAspectValue	getValue(OpenContextComponent occ, Element child)

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

ExplicitDimensionAspect

public ExplicitDimensionAspect(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 ExplicitDimensionAspectValue 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 ExplicitDimensionAspectValue 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)

getDefaultValue

public ExplicitDimensionAspectValue getDefaultValue(Store store)
                                             throws XBRLException

This method only determines the default value from the store on the first time. Thereafter it is cached, even if the data store changes.

Parameters:

store - The data store to use to get the default value.

Returns:

the default value for this dimension or the missing value if there is no default.

Throws:

XBRLException

getValue

public ExplicitDimensionAspectValue getValue(OpenContextComponent occ)
                                      throws XBRLException

Throws:

XBRLException

getValue

public ExplicitDimensionAspectValue getValue(OpenContextComponent occ,
                                             Element child)
                                      throws XBRLException

Throws:

XBRLException

getMissingValue

public ExplicitDimensionAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()