com.ihr.xbrl.dts
Class PMember

java.lang.Object
  com.ihr.xbrl.dts.PMember

All Implemented Interfaces:

Member<MemberInfo>, java.lang.Cloneable

public class PMember
extends java.lang.Object
implements Member<MemberInfo>

This class holds a domain of members

Author:

Ignacio

Constructor Summary

PMember(XBRLTreeNode node, DDimension dim)

PMember(XBRLTreeNode node, DDimension dim, boolean bRemoveXDTElements, XMLElementDefinition hc, XMLElementDefinition di)

PMember(XDTDomainMemberUse dmu, XDimension dim)

PMember(XMLElementDefinition item, Dimension<?> dim)

PMember(XMLElementDefinition item, XBRLRelationship rel, Dimension<?> dim)

Method Summary

void	addDomain(java.util.Collection<Member<?>> members) Adds a domain of members.
void	buildDomain(XBRLRelationship rel)
Member<MemberInfo>	clone() Clone constructor
void	collectDimensions(java.util.HashSet<ClsPackQNameContainer> hsDimensions, com.ihr.xbrl.dts.DimensionalInstanceExplorerCommonParametersContext dContext) Explore concept definition for additional dimensions and add them to the Dimensions HashSet
int	compareTo(Member<?> o2)
boolean	equals(java.lang.Object obj)
Dimension<?>	getDimension() Access back to the dimensions this member has belongs to
java.util.Collection<Member<?>>	getDomain() Returns the available sub members of this member.
HandleDateStep.InstantMode	getInstantMode()
MemberInfo	getMember() Access to the member.
boolean	hasDomain() Returns true if the member is a Domain and has sub-members
int	hashCode()
boolean	isAbstract() This method returns true if the member associated is abstract
boolean	isDefault()
boolean	isPrimary() This method returns true if the member is a primary item, otherwise is a dimension member of either an XDT dimension or a Virtual dimension
XMLFragment	toFragment(DTSContainer dts)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PMember

public PMember(XMLElementDefinition item,
               Dimension<?> dim)

PMember

public PMember(XMLElementDefinition item,
               XBRLRelationship rel,
               Dimension<?> dim)

PMember

public PMember(XDTDomainMemberUse dmu,
               XDimension dim)

Parameters:

dmu -

dim2 -

PMember

public PMember(XBRLTreeNode node,
               DDimension dim)

Parameters:

node -

dim2 -

PMember

public PMember(XBRLTreeNode node,
               DDimension dim,
               boolean bRemoveXDTElements,
               XMLElementDefinition hc,
               XMLElementDefinition di)

Parameters:

root -

dDimension -

bRemoveXDTElements -

di -

hc -

Method Detail

clone

public Member<MemberInfo> clone()

Description copied from interface: Member

Clone constructor

Specified by:

clone in interface Member<MemberInfo>

Overrides:

clone in class java.lang.Object

Returns:

buildDomain

public void buildDomain(XBRLRelationship rel)

getMember

public MemberInfo getMember()

Description copied from interface: Member

Access to the member.

Specified by:

getMember in interface Member<MemberInfo>

Returns:

element of the class of the Member type

getDomain

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

Description copied from interface: Member

Returns the available sub members of this member. In the case there were no sub-members the function returns null.

Specified by:

getDomain in interface Member<MemberInfo>

Returns:

Collection of sub members of class T

See Also:

#hasDomain()}

hasDomain

public boolean hasDomain()

Description copied from interface: Member

Returns true if the member is a Domain and has sub-members

Specified by:

hasDomain in interface Member<MemberInfo>

Returns:

boolean value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addDomain

public void addDomain(java.util.Collection<Member<?>> members)

Description copied from interface: Member

Adds a domain of members. This method should be called only if the member has no domain. This method should use the clone<T> method for adding copies of the members that are passed as parameter

Specified by:

addDomain in interface Member<MemberInfo>

isAbstract

public boolean isAbstract()

Description copied from interface: Member

This method returns true if the member associated is abstract

Specified by:

isAbstract in interface Member<MemberInfo>

Returns:

boolean

isPrimary

public boolean isPrimary()

Description copied from interface: Member

This method returns true if the member is a primary item, otherwise is a dimension member of either an XDT dimension or a Virtual dimension

Specified by:

isPrimary in interface Member<MemberInfo>

getDimension

public Dimension<?> getDimension()

Description copied from interface: Member

Access back to the dimensions this member has belongs to

Specified by:

getDimension in interface Member<MemberInfo>

Returns:

isDefault

public boolean isDefault()

Returns:

toFragment

public XMLFragment toFragment(DTSContainer dts)

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Member<?> o2)

Specified by:

compareTo in interface Member<MemberInfo>

Returns:

collectDimensions

public void collectDimensions(java.util.HashSet<ClsPackQNameContainer> hsDimensions,
                              com.ihr.xbrl.dts.DimensionalInstanceExplorerCommonParametersContext dContext)

Explore concept definition for additional dimensions and add them to the Dimensions HashSet

Parameters:

hsDimensions -

dContext.instance -

getInstantMode

public HandleDateStep.InstantMode getInstantMode()

Returns: