com.ihr.xbrl.om.xdt
Class XDTHypercubeUse

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

public class XDTHypercubeUse
extends java.lang.Object

Author:

Ignacio

Field Summary

static int	ALL
static int	DEFAULT
static int	NOTALL
static int	SCENARIO
static int	SEGMENT
static int	UNDEFINED Values of the contextElement attribute

Constructor Summary

XDTHypercubeUse(XDTProcessor processor, XDTHypercube hypercube, int arcRoleType, DTSBase useBase, DTSBase searchBase, DefinitionLinkbase tempDefLb)

Method Summary

int	getArcroleType() Returns ALL or NOTALL depending on how the surrounding hypercube is related to the primary item
boolean	getClosed() Returns true if the hypercube is closed, false if this is an open hypercube
int	getContextElement() Returns the container defined for this hypercube.
XDTDimensionUse	getDimension(javax.xml.namespace.QName key) Access to the object that represents the usage of the dimension in this hypercube.
java.util.Iterator<XDTDimensionUse>	getDimensions() Dimensions in the use of this hypercube
java.lang.String	getName() Access to the hypercube name. this is a string composed by the concept prefix colon and local name
int	getNumberOfDimensions()
javax.xml.namespace.QName	getQName() Access to the Hypercube QName.
DTSBase	getUseBase()
boolean	validate(java.util.Hashtable<javax.xml.namespace.QName,XMLFragment> htDimData, java.lang.StringBuffer trackOfHypercubeValidation, XDTValidationHypercube hypercubeSection) Validates this hypercube using dimensional data from the fact

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final int ALL

See Also:

Constant Field Values

NOTALL

public static final int NOTALL

See Also:

Constant Field Values

UNDEFINED

public static final int UNDEFINED

Values of the contextElement attribute

See Also:

Constant Field Values

SEGMENT

public static final int SEGMENT

See Also:

Constant Field Values

SCENARIO

public static final int SCENARIO

See Also:

Constant Field Values

DEFAULT

public static final int DEFAULT

See Also:

Constant Field Values

Constructor Detail

XDTHypercubeUse

public XDTHypercubeUse(XDTProcessor processor,
                       XDTHypercube hypercube,
                       int arcRoleType,
                       DTSBase useBase,
                       DTSBase searchBase,
                       DefinitionLinkbase tempDefLb)

Parameters:

processor -

hypercube -

arcRoleType -

searchBase -

tempDefLb -

Method Detail

getContextElement

public int getContextElement()

Returns the container defined for this hypercube. This is either SEGMENT of SCENARIO

Returns:

getClosed

public boolean getClosed()

Returns true if the hypercube is closed, false if this is an open hypercube

Returns:

boolean

getArcroleType

public int getArcroleType()

Returns ALL or NOTALL depending on how the surrounding hypercube is related to the primary item

Returns:

int

getUseBase

public DTSBase getUseBase()

validate

public boolean validate(java.util.Hashtable<javax.xml.namespace.QName,XMLFragment> htDimData,
                        java.lang.StringBuffer trackOfHypercubeValidation,
                        XDTValidationHypercube hypercubeSection)

Validates this hypercube using dimensional data from the fact

Parameters:

htDimData - Hashtable

trackOfHypercubeValidation -

hypercubeSection - XDTValidationHypercube instance to keep track of validation error details

Returns:

boolean

getName

public java.lang.String getName()

Access to the hypercube name. this is a string composed by the concept prefix colon and local name

Returns:

String

getQName

public javax.xml.namespace.QName getQName()

Access to the Hypercube QName. This is the Hypercube QName so the concept definition can be found in the DTS using other methods in the API and from that the labels etc. Note this is a HypercubeUse instance, so it is enclosed in a specific Base Set. The same Hypercube shall be used in multiple base sets if the hypercube is polymorfic or even if the hypercube is monomorphic

Returns:

the Hypercube concept QName

getDimensions

public java.util.Iterator<XDTDimensionUse> getDimensions()

Dimensions in the use of this hypercube

Returns:

Iterator

getNumberOfDimensions

public int getNumberOfDimensions()

getDimension

public XDTDimensionUse getDimension(javax.xml.namespace.QName key)

Access to the object that represents the usage of the dimension in this hypercube. The result is null if the hypercube does not contains the dimension.

Parameters:

key - QName of the dimension

Returns:

XDTDimensionUse or null if the hypercube does not use the specified dimension