com.ihr.xbrl.dts
Class PeriodMember

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

All Implemented Interfaces:

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

public class PeriodMember
extends java.lang.Object
implements Member<ColumnPeriod>

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

PeriodMember(ColumnPeriod cp, Dimension<?> dim)

PeriodMember(XBRLPeriod period, HasBoySupport hb, Dimension<?> dim, HandleDateStep.InstantMode instantMode)

Method Summary

void	addDomain(java.util.Collection<Member<?>> members) Adds a domain of members.
void	addPeriod(XBRLPeriod period) Adds a new XBRLPeriod to this column of periods.
Member<ColumnPeriod>	clone() Clone constructor
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.
ColumnPeriod	getMember() Access to the member.
XBRLPeriod	getPeriod() If this PeriodMember contains only one XBRLPeriod object this method returns it.
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	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
boolean	isVisible() Must return true if the member is going to be visualized in rows or columns.
Dimension<?>	setDimension(Dimension<?> newDimension) Set or change the assigned dimension of this member
void	setHidden()
void	setVisible()
void	setVisible(boolean value) Sets the visibility parameter value for this member
XBRLPeriod	toPeriod(DTSContainer container, XBRLItem.PeriodType type, HandleDateStep.InstantMode mode)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PeriodMember

public PeriodMember(XBRLPeriod period,
                    HasBoySupport hb,
                    Dimension<?> dim,
                    HandleDateStep.InstantMode instantMode)

PeriodMember

public PeriodMember(ColumnPeriod cp,
                    Dimension<?> dim)

Method Detail

addPeriod

public void addPeriod(XBRLPeriod period)

Adds a new XBRLPeriod to this column of periods. Only XBRLPeriods inside this column will be added.

Parameters:

period -

getPeriod

public XBRLPeriod getPeriod()

If this PeriodMember contains only one XBRLPeriod object this method returns it. Otherwise this method returns null.

This method is used when the PeriodMember has been created from one XBRLPeriod but has not been added to a PeriodDimension yet. At the time it is added to the PeriodDimension the XBRLPeriod is obtained in order to add the XBRLPeriod to an existing ColumnPeriod if it already exists.

Returns:

XBRLPeriod or null

clone

public Member<ColumnPeriod> clone()

Description copied from interface: Member

Clone constructor

Specified by:

clone in interface Member<ColumnPeriod>

Overrides:

clone in class java.lang.Object

Returns:

getMember

public ColumnPeriod getMember()

Description copied from interface: Member

Access to the member.

Specified by:

getMember in interface Member<ColumnPeriod>

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

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

Returns:

boolean value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

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

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

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

isVisible

public boolean isVisible()

Description copied from interface: Member

Must return true if the member is going to be visualized in rows or columns. If false, the member will be hidden and all children elements too

Specified by:

isVisible in interface Member<ColumnPeriod>

Returns:

boolean value

setVisible

public void setVisible()

setVisible

public void setVisible(boolean value)

Description copied from interface: Member

Sets the visibility parameter value for this member

Specified by:

setVisible in interface Member<ColumnPeriod>

setHidden

public void setHidden()

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

Returns:

setDimension

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

Description copied from interface: Member

Set or change the assigned dimension of this member

Specified by:

setDimension in interface Member<ColumnPeriod>

Returns:

the previouly assigned dimension or null

toPeriod

public XBRLPeriod toPeriod(DTSContainer container,
                           XBRLItem.PeriodType type,
                           HandleDateStep.InstantMode mode)

Parameters:

container -

type -

Returns:

compareTo

public int compareTo(Member<?> o2)

Specified by:

compareTo in interface Member<ColumnPeriod>

Returns: