com.ihr.xbrl.dts

Class PDimension

java.lang.Object

com.ihr.xbrl.dts.PDimension

All Implemented Interfaces:

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

public class PDimension
extends java.lang.Object
implements Dimension<MemberInfo>

Used to represent a hierarchical structure on the Primary Item. This is the domain-member structure of elements that can be found starting on the item passed as the constructor following the rules of the XDT specification in regard to the use of the targetRole attribute.

TODO: Note: not usable members are added to the domain. revisit later

Author:

Ignacio

Nested Class Summary

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

Dimension.DimensionType

Field Summary

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
PDimension(XDTPrimaryItem pItem, XBRLRoleType role) Used for representing domain-member structures.

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> dimensionsToMatch, 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.
static javax.xml.namespace.QName	getName(XDTPrimaryItem pri) Gets the name.
XBRLItem	getParentItem() Gets the parent item.
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

Constructor Detail

PDimension

public PDimension(XDTPrimaryItem pItem,
                  XBRLRoleType role)
           throws com.rs.lic.LicenseVerificationException,
                  XBRLValidationException

Used for representing domain-member structures.

Parameters:

pItem - the item

role - the role where domain-member relationships will be explored at

Throws:

com.rs.lic.LicenseVerificationException - the license verification exception

XBRLValidationException - the XBRL validation exception

Method Detail

getParentItem

public XBRLItem getParentItem()

Gets the parent item.

Returns:

the parent item

addMember

public boolean addMember(Member<?> member)

Adds the member.

Specified by:

addMember in interface Dimension<MemberInfo>

Parameters:

member - the member

Returns:

true, if successful

delMember

public boolean delMember(Member<?> member)

Del member.

Specified by:

delMember in interface Dimension<MemberInfo>

Parameters:

member - the member

Returns:

true, if successful

bHasFixedName

public boolean bHasFixedName()

B has fixed name.

Specified by:

bHasFixedName in interface Dimension<MemberInfo>

Returns:

true, if successful

getDimensionName

public java.lang.String getDimensionName()

Gets the dimension name.

Specified by:

getDimensionName in interface Dimension<MemberInfo>

Returns:

the dimension name

getSuggestedInitialPosition

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

Gets the suggested initial position.

Specified by:

getSuggestedInitialPosition in interface Dimension<MemberInfo>

Parameters:

selectedPrimaryItem - the selected primary item

Returns:

the suggested initial position

setAllowDuplicates

public void setAllowDuplicates(boolean allowDuplicates)

Sets the allow duplicates.

Specified by:

setAllowDuplicates in interface Dimension<MemberInfo>

Parameters:

allowDuplicates - the new allow duplicates

getMembers

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

Gets the members.

Specified by:

getMembers in interface Dimension<MemberInfo>

Returns:

the members

isTree

public boolean isTree()

Checks if is tree.

Specified by:

isTree in interface Dimension<MemberInfo>

Returns:

true, if is tree

isXDTDimension

public boolean isXDTDimension()

Checks if is XDT dimension.

Specified by:

isXDTDimension in interface Dimension<MemberInfo>

Returns:

true, if is XDT dimension

getDimension

public XDTDimension getDimension()

Gets the dimension.

Specified by:

getDimension in interface Dimension<MemberInfo>

Returns:

the dimension

getDomain

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

Gets the domain.

Specified by:

getDomain in interface Dimension<MemberInfo>

Returns:

the domain

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Dimension<MemberInfo>

Returns:

true, if is primary

factMatches

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

Fact matches.

Specified by:

factMatches in interface Dimension<MemberInfo>

Parameters:

item - the item

mem - the mem

dimensionsToMatch - the dimensions to match

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<MemberInfo>

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<MemberInfo>

Returns:

the default

getName

public javax.xml.namespace.QName getName()

Gets the name.

Specified by:

getName in interface Dimension<MemberInfo>

Returns:

the name

getName

public static javax.xml.namespace.QName getName(XDTPrimaryItem pri)

Gets the name.

Parameters:

pri - the pri

Returns:

the name

findMember

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

Find member.

Specified by:

findMember in interface Dimension<MemberInfo>

Parameters:

mem - the mem

Returns:

the member

getType

public Dimension.DimensionType getType()

Gets the type.

Specified by:

getType in interface Dimension<MemberInfo>

Returns:

the type

compareTo

public int compareTo(Dimension<?> o)

Compare to.

Specified by:

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

Parameters:

o - the o

Returns:

the int

getMemberFromString

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

Gets the member from string.

Specified by:

getMemberFromString in interface Dimension<MemberInfo>

Parameters:

value - the value

Returns:

the member from string

isOpen

public boolean isOpen()

Checks if is open.

Specified by:

isOpen in interface Dimension<MemberInfo>

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<MemberInfo>

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<MemberInfo>

Overrides:

hashCode in class java.lang.Object

Returns:

the int