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>

The Class PeriodMember.

Author:

Ignacio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PeriodMember(ColumnPeriod cp, Dimension<?> dim) Instantiates a new period member.
PeriodMember(XBRLPeriod period, HasBoySupport hb, Dimension<?> dim) Instantiates a new period member.

Method Summary

Modifier and Type	Method and Description
void	addDomain(java.util.Collection<Member<?>> members) Adds the domain.
void	addPeriod(XBRLPeriod period) Adds a new XBRLPeriod to this column of periods.
PeriodMember	clone() Clone.
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.
ColumnPeriod	getMember() Gets the member.
XBRLPeriod	getPeriod() If this PeriodMember contains only one XBRLPeriod object this method returns it.
boolean	hasDomain() Checks for domain.
int	hashCode() Hash code.
boolean	isAbstract() Checks if is abstract.
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.
XBRLPeriod	toPeriod(DTSContainer container, XBRLItem.PeriodType type, HandleDateStep.InstantMode mode) To period.
java.lang.String	toString() To string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PeriodMember

public PeriodMember(XBRLPeriod period,
                    HasBoySupport hb,
                    Dimension<?> dim)

Instantiates a new period member.

Parameters:

period - the period

hb - the hb

dim - the dim

PeriodMember

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

Instantiates a new period member.

Parameters:

cp - the cp

dim - the 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 - the 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 PeriodMember clone()

Clone.

Specified by:

clone in interface Member<ColumnPeriod>

Overrides:

clone in class java.lang.Object

Returns:

the period member

getMember

public ColumnPeriod getMember()

Gets the member.

Specified by:

getMember in interface Member<ColumnPeriod>

Returns:

the member

getDomain

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

Gets the domain.

Specified by:

getDomain in interface Member<ColumnPeriod>

Returns:

the domain

See Also:

Member.hasDomain()

hasDomain

public boolean hasDomain()

Checks for domain.

Specified by:

hasDomain in interface Member<ColumnPeriod>

Returns:

true, if successful

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

Returns:

boolean value

toString

public java.lang.String toString()

To string.

Specified by:

toString in interface Member<ColumnPeriod>

Overrides:

toString in class java.lang.Object

Returns:

the string

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

addDomain

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

Adds the domain.

Specified by:

addDomain in interface Member<ColumnPeriod>

Parameters:

members - the members

isAbstract

public boolean isAbstract()

Checks if is abstract.

Specified by:

isAbstract in interface Member<ColumnPeriod>

Returns:

true, if is abstract

isPrimary

public boolean isPrimary()

Checks if is primary.

Specified by:

isPrimary in interface Member<ColumnPeriod>

Returns:

true, if is primary

isVisible

public boolean isVisible()

Checks if is visible.

Specified by:

isVisible in interface Member<ColumnPeriod>

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

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

Returns:

the dimension

setDimension

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

Sets the dimension.

Specified by:

setDimension in interface Member<ColumnPeriod>

Parameters:

newDimension - the new dimension

Returns:

the dimension

toPeriod

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

To period.

Parameters:

container - the container

type - the type

mode - the mode

Returns:

the XBRL period

compareTo

public int compareTo(Member<?> o2)

Compare to.

Specified by:

compareTo in interface Member<ColumnPeriod>

Parameters:

o2 - the o 2

Returns:

the int

isTotal

public boolean isTotal()

Checks if is total.

Specified by:

isTotal in interface Member<ColumnPeriod>

Returns:

true, if is total

isNet

public boolean isNet()

Checks if is net.

Specified by:

isNet in interface Member<ColumnPeriod>

Returns:

true, if is net

isNegated

public boolean isNegated()

Checks if is negated.

Specified by:

isNegated in interface Member<ColumnPeriod>

Returns:

true, if is negated