org.xbrlapi.xdt.values
Class DimensionValueImpl

java.lang.Object
  org.xbrlapi.xdt.values.DimensionValueImpl

All Implemented Interfaces:

DimensionValue

public class DimensionValueImpl
extends Object
implements DimensionValue

Constructor Summary

DimensionValueImpl(Item item, Dimension dimension, OpenContextComponent occ, Object value)
Construct a dimension value.

Method Summary

Dimension	getDimension()
Item	getItem()
OpenContextComponent	getOpenContextComponent()
Object	getValue()
boolean	isExplicitDimensionValue()
boolean	isTypedDimensionValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionValueImpl

public DimensionValueImpl(Item item,
                          Dimension dimension,
                          OpenContextComponent occ,
                          Object value)
                   throws XBRLException

Construct a dimension value.

Parameters:

item - The item that has the dimension value.

dimension - The dimension with the value.

occ - The open context component (segment or scenario) - null if the value is a default dimension value.

value - The dimension value object (that must be one of an org.xbrlapi.Concept or a org.w3c.dom.Element) where the class of the object matches the type of dimension.

Throws:

XBRLException.

XBRLException

Method Detail

getItem

public Item getItem()
             throws XBRLException

Specified by:

getItem in interface DimensionValue

Returns:

the item with this dimension value.

Throws:

XBRLException - if the item is null.

See Also:

DimensionValue.getItem()

getDimension

public Dimension getDimension()
                       throws XBRLException

Specified by:

getDimension in interface DimensionValue

Returns:

the dimension that the value is for.

Throws:

XBRLException - if the dimension cannot be retrieved.

See Also:

DimensionValue.getDimension()

getValue

public Object getValue()
                throws XBRLException

Specified by:

getValue in interface DimensionValue

Returns:

an object that is either the XML DOM Element that is the child element of the open context container (segment or scenario) that expresses the dimension value for typed dimensions; and that is the concept fragment that is the domain member, for explicit dimensions.

Throws:

XBRLException - if the value cannot be retrieved.

See Also:

DimensionValue.getValue()

getOpenContextComponent

public OpenContextComponent getOpenContextComponent()
                                             throws XBRLException

Specified by:

getOpenContextComponent in interface DimensionValue

Returns:

The OCC containing the dimension value or null if the dimension value is a default one.

Throws:

XBRLException

See Also:

DimensionValue.getOpenContextComponent()

isExplicitDimensionValue

public boolean isExplicitDimensionValue()
                                 throws XBRLException

Specified by:

isExplicitDimensionValue in interface DimensionValue

Returns:

true if the dimension value is an explicit dimension value and false otherwise.

Throws:

XBRLException

See Also:

DimensionValue.isExplicitDimensionValue()

isTypedDimensionValue

public boolean isTypedDimensionValue()
                              throws XBRLException

Specified by:

isTypedDimensionValue in interface DimensionValue

Returns:

true if the dimension value is a typed dimension value and false otherwise.

Throws:

XBRLException

See Also:

DimensionValue.isTypedDimensionValue()