com.ihr.xbrl.om.xdt
Class XDTDimensionUse

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

public class XDTDimensionUse
extends java.lang.Object

Author:

Ignacio

Constructor Summary

XDTDimensionUse(XDTProcessor processor, XDTDimension dimension, DTSBase base, DefinitionLinkbase tempDefLb)

Method Summary

XDTDimension	getDimension()
java.util.Iterator<javax.xml.namespace.QName>	getDomain() Returns an iterator over the entire domain, some members may not be usable use the function isUsable to check each member's usability.
javax.xml.namespace.QName	getExplicitMemberValue(XBRLDimensionsContainer container) Helper method, not used inside the XDT validation engine but available for applications using the XDT model returns the value (QName) from the context container or from the default value of the dimension.
javax.xml.namespace.QName	getExplicitMemberValue(XBRLFactItem fact, int container) Helper method, not used inside the XDT validation engine but available for applications using the XDT model returns the value (QName) from the context or from the default value of the dimension.
java.lang.String	getName()
int	getNumberOfMembers() Returns the number of members in the domain (usable and not usable)
java.util.Collection<XDTDomainMemberUse>	getUsesOfDomainMembers() Access to the dimension domain using the object model of the XDT representation.
boolean	isUsable(javax.xml.namespace.QName member) Returns true if the member belongs to the domain and is usable
boolean	validate(XMLFragment info, java.lang.StringBuffer dimensionValidation) This method validates the content of a dimension against the domain of members for the dimension.

Methods inherited from class java.lang.Object

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

Constructor Detail

XDTDimensionUse

public XDTDimensionUse(XDTProcessor processor,
                       XDTDimension dimension,
                       DTSBase base,
                       DefinitionLinkbase tempDefLb)

Parameters:

processor -

dimension -

base -

tempDefLb -

Method Detail

getUsesOfDomainMembers

public java.util.Collection<XDTDomainMemberUse> getUsesOfDomainMembers()

Access to the dimension domain using the object model of the XDT representation. This is the uses of the objects independent of the syntax in the taxonomy.

The returned collection is ordered according to the order attribute of the relationships in the taxonomy

Returns:

Collection of XDTDomainMemberUse objects that represents the use of Domain Members of a dimension

validate

public boolean validate(XMLFragment info,
                        java.lang.StringBuffer dimensionValidation)

This method validates the content of a dimension against the domain of members for the dimension.

Parameters:

info - the nodeInfo of the explicit dimension usage in the context of the fact or null if the default value will be used

dimensionValidation -

Returns:

boolean indicating if the dimension is satisfied or throws XDTRuntimeException if there is an XDT error

getExplicitMemberValue

public javax.xml.namespace.QName getExplicitMemberValue(XBRLFactItem fact,
                                                        int container)

Helper method, not used inside the XDT validation engine but available for applications using the XDT model returns the value (QName) from the context or from the default value of the dimension.

Parameters:

fact - the XBRLFactItem

container - either XDTHypercubeUse.SEGMENT or XDTHypercubeUse.SCENARIO

Returns:

QName the value or null if no value exist

getExplicitMemberValue

public javax.xml.namespace.QName getExplicitMemberValue(XBRLDimensionsContainer container)

Helper method, not used inside the XDT validation engine but available for applications using the XDT model returns the value (QName) from the context container or from the default value of the dimension.

Parameters:

container - XBRLDimensionsContaienr object

Returns:

QName the value or null if no value exist

getDimension

public XDTDimension getDimension()

getName

public java.lang.String getName()

getDomain

public java.util.Iterator<javax.xml.namespace.QName> getDomain()

Returns an iterator over the entire domain, some members may not be usable use the function isUsable to check each member's usability.

Returns:

Iterator

getNumberOfMembers

public int getNumberOfMembers()

Returns the number of members in the domain (usable and not usable)

isUsable

public boolean isUsable(javax.xml.namespace.QName member)

Returns true if the member belongs to the domain and is usable

Parameters:

member -

Returns:

boolean