org.xbrlapi.xdt.aspects
Class DimensionAspect

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

All Implemented Interfaces:

Serializable, Aspect

Direct Known Subclasses:

ExplicitDimensionAspect, TypedDimensionAspect

public abstract class DimensionAspect
extends AspectImpl
implements Aspect

XDT dimension aspect details

This class provides for functionality that is common to both explicit and typed dimensions.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.aspects.AspectImpl

domain

Constructor Summary

DimensionAspect(Domain domain, URI dimensionNamespace, String dimensionLocalname)

Method Summary

String	getDimensionLocalname()
URI	getDimensionNamespace()
URI	getId()
boolean	isExtensible()

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue, 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, getMissingValue, getValue, getValue, getValue

Constructor Detail

DimensionAspect

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

Parameters:

domain - The domain for this aspect.

dimensionNamespace - The namespace for this dimension aspect.

dimensionLocalname - The local name for this dimension aspect.

Throws:

XBRLException - if the dimension namespace or local name are null.

Method Detail

getId

public URI getId()

Specified by:

getId in interface Aspect

Returns:

the URI that identifies this aspect.

See Also:

Aspect.getId()

isExtensible

public boolean isExtensible()

Specified by:

isExtensible in interface Aspect

Overrides:

isExtensible in class AspectImpl

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.

See Also:

Aspect.isExtensible()

getDimensionNamespace

public URI getDimensionNamespace()

getDimensionLocalname

public String getDimensionLocalname()