com.ihr.xbrl.dts

Class TDimension

java.lang.Object

com.ihr.xbrl.dts.TDimension

All Implemented Interfaces:

Dimension<java.lang.Object>, java.lang.Comparable<Dimension<?>>

public class TDimension
extends java.lang.Object
implements Dimension<java.lang.Object>

This is a dimension to bridge the table linkbase specification with the XBRLizer representation model In this case, the TDimension holds the primary items to be reported for each particular cell.

Author:

Ignacio

Nested Class Summary

Nested classes/interfaces inherited from interface com.ihr.xbrl.dts.Dimension

Dimension.DimensionType

Field Summary

Fields

Modifier and Type	Field and Description
static TDimension	ENTITYIDENTIFIER The entityidentifier.
static TDimension	EXPLICITDIMENSION The explicitdimension.
static TDimension	PERIODDIMENSION The perioddimension.
static TDimension	PRIMARYITEM The primaryitem.
static TDimension	TYPEDDIMENSION The typeddimension.

Fields inherited from interface com.ihr.xbrl.dts.Dimension

defaultDimensionsXBRL, duplicatesDimension, entityDimension, formLineDimenion, instantModeDimension, instantOnDurationDimension, periodDimensionCombined, periodDimensionDuration, periodDimensionInstant, POSITION_AVAIL, POSITION_COLUMN_HEADERS, POSITION_ROW_HEADERS, POSITION_UNKNOWN, rowOrColumnLabelDimension, RSDimensionsNameNamespace, RSDimensionsNameNamespacePrefix, unitDimension

Constructor Summary

Constructors

Constructor and Description
TDimension(javax.xml.namespace.QName dimension, boolean isExplicit) Instantiates a new t dimension.

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Member<?> member) Adds the member.
boolean	bHasFixedName() B has fixed name.
int	compareTo(Dimension<?> o) Compare to.
boolean	delMember(Member<?> member) Del member.
boolean	equals(java.lang.Object other) Equals.
boolean	factMatches(XDTFactWithVirtualDimensions item, Member<?> mem, java.lang.Object contextualExtraInformation) Fact matches.
boolean	factMatches(XDTFactWithVirtualDimensions item, Member<?> mem, java.util.Set<javax.xml.namespace.QName> dimsToMatchOnThisRound, java.lang.Object contextualExtraInformation) Fact matches.
Member<?>	findMember(Member<?> mem) Find member.
Member<?>	getDefault() Gets the default.
XDTDimension	getDimension() Gets the dimension.
java.lang.String	getDimensionName() Gets the dimension name.
java.util.Collection<Member<?>>	getDomain() Gets the domain.
Member<?>	getMemberFromString(java.lang.String value) Gets the member from string.
java.util.Collection<Member<?>>	getMembers() Gets the members.
javax.xml.namespace.QName	getName() Gets the name.
int	getSuggestedInitialPosition(javax.xml.namespace.QName selectedPrimaryItem) Gets the suggested initial position.
Dimension.DimensionType	getType() Gets the type.
int	hashCode() Hash code.
boolean	isOpen() Checks if is open.
boolean	isPrimary() Checks if is primary.
boolean	isTree() Checks if is tree.
boolean	isXDTDimension() Checks if is XDT dimension.
void	setAllowDuplicates(boolean allowDuplicates) Sets the allow duplicates.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRIMARYITEM

public static TDimension PRIMARYITEM

The primaryitem.

EXPLICITDIMENSION

public static TDimension EXPLICITDIMENSION

The explicitdimension.

TYPEDDIMENSION

public static TDimension TYPEDDIMENSION

The typeddimension.

ENTITYIDENTIFIER

public static TDimension ENTITYIDENTIFIER

The entityidentifier.

PERIODDIMENSION

public static TDimension PERIODDIMENSION

The perioddimension.

Constructor Detail

TDimension

public TDimension(javax.xml.namespace.QName dimension,
                  boolean isExplicit)

Instantiates a new t dimension.

Parameters:

dimension - the dimension

isExplicit - the is explicit

Method Detail

compareTo

public int compareTo(Dimension<?> o)

Compare to.

Specified by:

compareTo in interface java.lang.Comparable<Dimension<?>>

Parameters:

o - the o

Returns:

the int

getName

public javax.xml.namespace.QName getName()

Gets the name.

Specified by:

getName in interface Dimension<java.lang.Object>

Returns:

the name

setAllowDuplicates

public void setAllowDuplicates(boolean allowDuplicates)

Sets the allow duplicates.

Specified by:

setAllowDuplicates in interface Dimension<java.lang.Object>

Parameters:

allowDuplicates - the new allow duplicates

addMember

public boolean addMember(Member<?> member)

Adds the member.

Specified by:

addMember in interface Dimension<java.lang.Object>

Parameters:

member - the member

Returns:

true, if successful

delMember

public boolean delMember(Member<?> member)

Del member.

Specified by:

delMember in interface Dimension<java.lang.Object>

Parameters:

member - the member

Returns:

true, if successful

bHasFixedName

public boolean bHasFixedName()

B has fixed name.

Specified by:

bHasFixedName in interface Dimension<java.lang.Object>

Returns:

true, if successful

getDimensionName

public java.lang.String getDimensionName()

Gets the dimension name.

Specified by:

getDimensionName in interface Dimension<java.lang.Object>

Returns:

the dimension name

getSuggestedInitialPosition

public int getSuggestedInitialPosition(javax.xml.namespace.QName selectedPrimaryItem)

Gets the suggested initial position.

Specified by:

getSuggestedInitialPosition in interface Dimension<java.lang.Object>

Parameters:

selectedPrimaryItem - the selected primary item

Returns:

the suggested initial position

getMembers

public java.util.Collection<Member<?>> getMembers()

Gets the members.

Specified by:

getMembers in interface Dimension<java.lang.Object>

Returns:

the members

getDomain

public java.util.Collection<Member<?>> getDomain()

Gets the domain.

Specified by:

getDomain in interface Dimension<java.lang.Object>

Returns:

the domain

isTree

public boolean isTree()

Checks if is tree.

Specified by:

isTree in interface Dimension<java.lang.Object>

Returns:

true, if is tree

isXDTDimension

public boolean isXDTDimension()

Checks if is XDT dimension.

Specified by:

isXDTDimension in interface Dimension<java.lang.Object>

Returns:

true, if is XDT dimension

getDimension

public XDTDimension getDimension()

Gets the dimension.

Specified by:

getDimension in interface Dimension<java.lang.Object>

Returns:

the dimension

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Dimension<java.lang.Object>

Returns:

true, if is primary

findMember

public Member<?> findMember(Member<?> mem)

Find member.

Specified by:

findMember in interface Dimension<java.lang.Object>

Parameters:

mem - the mem

Returns:

the member

factMatches

public boolean factMatches(XDTFactWithVirtualDimensions item,
                           Member<?> mem,
                           java.util.Set<javax.xml.namespace.QName> dimsToMatchOnThisRound,
                           java.lang.Object contextualExtraInformation)

Fact matches.

Specified by:

factMatches in interface Dimension<java.lang.Object>

Parameters:

item - the item

mem - the mem

dimsToMatchOnThisRound - the dims to match on this round

contextualExtraInformation - the contextual extra information

Returns:

true, if successful

factMatches

public boolean factMatches(XDTFactWithVirtualDimensions item,
                           Member<?> mem,
                           java.lang.Object contextualExtraInformation)

Fact matches.

Specified by:

factMatches in interface Dimension<java.lang.Object>

Parameters:

item - the item

mem - the mem

contextualExtraInformation - the contextual extra information

Returns:

true, if successful

getDefault

public Member<?> getDefault()

Gets the default.

Specified by:

getDefault in interface Dimension<java.lang.Object>

Returns:

the default

getType

public Dimension.DimensionType getType()

Gets the type.

Specified by:

getType in interface Dimension<java.lang.Object>

Returns:

the type

getMemberFromString

public Member<?> getMemberFromString(java.lang.String value)

Gets the member from string.

Specified by:

getMemberFromString in interface Dimension<java.lang.Object>

Parameters:

value - the value

Returns:

the member from string

isOpen

public boolean isOpen()

Checks if is open.

Specified by:

isOpen in interface Dimension<java.lang.Object>

Returns:

true, if is open

equals

public boolean equals(java.lang.Object other)

Description copied from interface: Dimension

Equals.

Specified by:

equals in interface Dimension<java.lang.Object>

Overrides:

equals in class java.lang.Object

Parameters:

other - the other

Returns:

true, if successful

hashCode

public int hashCode()

Description copied from interface: Dimension

Hash code.

Specified by:

hashCode in interface Dimension<java.lang.Object>

Overrides:

hashCode in class java.lang.Object

Returns:

the int