com.ihr.xbrl.om.xdt
Class XDTPrimaryItem

java.lang.Object
  com.ihr.xbrl.om.xdt.XDTPrimaryItem

public class XDTPrimaryItem
extends java.lang.Object

An XDTPrimaryItem represents a concept definition XBRLItem that has dimensional information explicitly declared in the DTS. That is, it is linked with hypercubes directly or indirectly via inheritance mechanisms.

Author:

Ignacio

Constructor Summary

XDTPrimaryItem(XBRLItem item)
Creates a new XDTPrimaryItem instantiation.

Method Summary

java.util.Iterator<DTSBase>	getBases() Returns an iterator over DTSBase objects in which this XDTPrimary item has hypercubes that are directly or indirectly related but all providing real validation rules that requires to be validated.
java.util.Iterator<XDTHypercubeUse>	getHypercubes(DTSBase base) Access to all Hypercube uses in the specific base set.
XBRLItem	getItem() Access to the surrounding primary item.
void	setAffectedByHypercube(XDTHypercubeUse hypercube, XDTPrimaryItemUse primaryItemUse) Set this object as affected by the hypercube received as a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

XDTPrimaryItem

public XDTPrimaryItem(XBRLItem item)

Creates a new XDTPrimaryItem instantiation. There should be just one object of this type in the DTS. The XDTProcessor automatically creates it and store the instance in a cache indexed by QName

Parameters:

item -

See Also:

XDTProcessor.getPrimaryItem(QName q)

Method Detail

getItem

public XBRLItem getItem()

Access to the surrounding primary item.

Returns:

XBRLItem the item concept definition

setAffectedByHypercube

public void setAffectedByHypercube(XDTHypercubeUse hypercube,
                                   XDTPrimaryItemUse primaryItemUse)

Set this object as affected by the hypercube received as a parameter. Cascade to all XDTPrimaryItem objects in the dom-mem network

Parameters:

hypercube -

primaryItemUse -

getBases

public java.util.Iterator<DTSBase> getBases()

Returns an iterator over DTSBase objects in which this XDTPrimary item has hypercubes that are directly or indirectly related but all providing real validation rules that requires to be validated.

According to the XDT specification, at least all hypercubes in one DTSBase MUST be dimensionally valid.

Returns:

Iterator<DTSBase>

getHypercubes

public java.util.Iterator<XDTHypercubeUse> getHypercubes(DTSBase base)

Access to all Hypercube uses in the specific base set. Each hypercube use may be different from primary item to primary item.

According to the XDT specification, all hypercubes in a base set MUST be dimensionally valid in order to consider the primary item is dimensionally valid

Parameters:

base -

Returns:

Iterator<XDTHypercubeUse>