com.ihr.xbrl.dts

Class PMember

java.lang.Object

com.ihr.xbrl.dts.PMember

All Implemented Interfaces:

Member<MemberInfo>, java.io.Serializable, java.lang.Cloneable

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

This class holds a domain of members.

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PMember(XBRLTreeNode node, DDimension dim) Instantiates a new p member.
PMember(XBRLTreeNode node, DDimension dim, boolean bRemoveXDTElements, XMLElementDefinition hc, XMLElementDefinition di) Instantiates a new p member.
PMember(XDTDomainMemberUse dmu, XDimension dim) Instantiates a new p member.
PMember(XMLElementDefinition item, Dimension<?> dim) Instantiates a new p member.
PMember(XMLElementDefinition item, XBRLRelationship rel, Dimension<?> dim) Instantiates a new p member.

Method Summary

Modifier and Type	Method and Description
void	addDomain(java.util.Collection<Member<?>> members) Adds the domain.
void	buildDomain(XBRLRelationship rel) Builds the domain.
PMember	clone() Clone.
void	collectDimensions(java.util.Set<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) Compare to.
boolean	equals(java.lang.Object obj) Equals.
Dimension<?>	getDimension() Gets the dimension.
java.util.Collection<Member<?>>	getDomain() Gets the domain.
HandleDateStep.InstantMode	getInstantMode() Gets the instant mode.
MemberInfo	getMember() Gets the member.
boolean	hasDomain() Checks for domain.
int	hashCode() Hash code.
boolean	isAbstract() Checks if is abstract.
boolean	isBOY() Returns true when the label role assigned to this PMember is used for the beginning of year.
boolean	isDefault() Checks if is default.
boolean	isEOY() Returns true when the label role assigned to this PMember is used for the end of year.
boolean	isNegated() Checks if is negated.
boolean	isNet() Checks if is net.
boolean	isPrimary() Checks if is primary.
boolean	isTotal() Checks if is total.
boolean	isUsable() When the member is part of a dimensional domain, this method returns true if the target member is usable or false if it is not
boolean	isVisible() Checks if is visible.
Dimension<?>	setDimension(Dimension<?> newDimension) Sets the dimension.
void	setHidden() Sets the hidden.
void	setVisible() Sets the visible.
void	setVisible(boolean value) Sets the visible.
XMLFragment	toFragment(DTSContainer dts) To fragment.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PMember

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

Instantiates a new p member.

Parameters:

item - the item

dim - the dim

PMember

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

Instantiates a new p member.

Parameters:

item - the item

rel - the rel

dim - the dim

PMember

public PMember(XDTDomainMemberUse dmu,
               XDimension dim)

Instantiates a new p member.

Parameters:

dmu - the dmu

dim - the dim

PMember

public PMember(XBRLTreeNode node,
               DDimension dim)

Instantiates a new p member.

Parameters:

node - the node

dim - the dim

PMember

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

Instantiates a new p member.

Parameters:

node - the node

dim - the dim

bRemoveXDTElements - the b remove xdt elements

hc - the hc

di - the di

Method Detail

clone

public PMember clone()

Clone.

Specified by:

clone in interface Member<MemberInfo>

Overrides:

clone in class java.lang.Object

Returns:

the p member

buildDomain

public void buildDomain(XBRLRelationship rel)

Builds the domain.

Parameters:

rel - the rel

getMember

public MemberInfo getMember()

Gets the member.

Specified by:

getMember in interface Member<MemberInfo>

Returns:

the member

getDomain

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

Gets the domain.

Specified by:

getDomain in interface Member<MemberInfo>

Returns:

the domain

See Also:

Member.hasDomain()

hasDomain

public boolean hasDomain()

Checks for domain.

Specified by:

hasDomain in interface Member<MemberInfo>

Returns:

true, if successful

toString

public java.lang.String toString()

To string.

Specified by:

toString in interface Member<MemberInfo>

Overrides:

toString in class java.lang.Object

Returns:

the string

isTotal

public boolean isTotal()

Checks if is total.

Specified by:

isTotal in interface Member<MemberInfo>

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Specified by:

isNet in interface Member<MemberInfo>

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Specified by:

isNegated in interface Member<MemberInfo>

Returns:

true, if is negated

isBOY

public boolean isBOY()

Returns true when the label role assigned to this PMember is used for the beginning of year.

Returns:

boolean value

isEOY

public boolean isEOY()

Returns true when the label role assigned to this PMember is used for the end of year.

Returns:

boolean value

addDomain

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

Adds the domain.

Specified by:

addDomain in interface Member<MemberInfo>

Parameters:

members - the members

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in interface Member<MemberInfo>

Returns:

true, if is abstract

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Member<MemberInfo>

Returns:

true, if is primary

isVisible

public boolean isVisible()

Checks if is visible.

Specified by:

isVisible in interface Member<MemberInfo>

Returns:

true, if is visible

setVisible

public void setVisible()

Sets the visible.

setVisible

public void setVisible(boolean value)

Sets the visible.

Specified by:

setVisible in interface Member<MemberInfo>

Parameters:

value - the new visible

setHidden

public void setHidden()

Sets the hidden.

getDimension

public Dimension<?> getDimension()

Gets the dimension.

Specified by:

getDimension in interface Member<MemberInfo>

Returns:

the dimension

setDimension

public Dimension<?> setDimension(Dimension<?> newDimension)

Sets the dimension.

Specified by:

setDimension in interface Member<MemberInfo>

Parameters:

newDimension - the new dimension

Returns:

the dimension

isDefault

public boolean isDefault()

Checks if is default.

Returns:

true, if is default

isUsable

public boolean isUsable()

Description copied from interface: Member

When the member is part of a dimensional domain, this method returns true if the target member is usable or false if it is not

Specified by:

isUsable in interface Member<MemberInfo>

Returns:

boolean value

toFragment

public XMLFragment toFragment(DTSContainer dts)

To fragment.

Parameters:

dts - the dts

Returns:

the XML fragment

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

compareTo

public int compareTo(Member<?> o2)

Compare to.

Specified by:

compareTo in interface Member<MemberInfo>

Parameters:

o2 - the o 2

Returns:

the int

collectDimensions

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

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

Parameters:

hsDimensions - the hs dimensions

dContext - the d context

getInstantMode

public HandleDateStep.InstantMode getInstantMode()

Gets the instant mode.

Returns:

the instant mode