com.ihr.xbrl.om.table.definition

Class PeriodAspectNode

java.lang.Object

com.ihr.xbrl.om.table.definition.PeriodAspectNode

All Implemented Interfaces:

HasAspectNode, MutableAspectValue, PeriodsAspectInterface, Aspect<XBRLPeriod>

public class PeriodAspectNode
extends java.lang.Object
implements PeriodsAspectInterface, HasAspectNode

The Class PeriodAspectNode.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
PeriodAspectNode(XBRLAspectNode node) Instantiates a new period aspect node.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAspectClashIdentity() Returns an object that can be used to evaluate aspect clash.
XBRLAspectNode	getAspectNode() Returns back the aspect node this resolves comes from.
int	getAspectType() Returns a value from the CommonAspectRule class that identifies the aspect type.
java.lang.String	getLabel(CellHeader ch) Returns a text representation of the aspect value that can be used in the GUI as the cell header.
XBRLPeriod	getMember(XBRLStructuralTable table, CellHeader[] header) Convert this aspect into a proper Member
int	getMembersCount() Gets the members count.
XBRLPeriod[]	getPeriods() Gets the period.
XBRLItem.PeriodType	getPeriodType(XBRLItem item) Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT
void	setValues(java.util.Set<?> distinctValues) Sets the values.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeriodAspectNode

public PeriodAspectNode(XBRLAspectNode node)

Instantiates a new period aspect node.

Parameters:

node - the node

Method Detail

getAspectNode

public XBRLAspectNode getAspectNode()

Description copied from interface: HasAspectNode

Returns back the aspect node this resolves comes from.

Specified by:

getAspectNode in interface HasAspectNode

Returns:

XBRLAspectNode

getAspectClashIdentity

public java.lang.Object getAspectClashIdentity()

Description copied from interface: Aspect

Returns an object that can be used to evaluate aspect clash.

Specified by:

getAspectClashIdentity in interface Aspect<XBRLPeriod>

Returns:

the aspect clash identity

getAspectType

public int getAspectType()

Description copied from interface: Aspect

Returns a value from the CommonAspectRule class that identifies the aspect type.

Specified by:

getAspectType in interface Aspect<XBRLPeriod>

Returns:

the aspect type

getPeriodType

public XBRLItem.PeriodType getPeriodType(XBRLItem item)

Description copied from interface: PeriodsAspectInterface

Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT

Specified by:

getPeriodType in interface PeriodsAspectInterface

Parameters:

item - the item

Returns:

the period type

getPeriods

public XBRLPeriod[] getPeriods()

Description copied from interface: PeriodsAspectInterface

Gets the period.

Specified by:

getPeriods in interface PeriodsAspectInterface

Returns:

the period

setValues

public void setValues(java.util.Set<?> distinctValues)

Description copied from interface: MutableAspectValue

Sets the values.

Specified by:

setValues in interface MutableAspectValue

Parameters:

distinctValues - the new values

getMembersCount

public int getMembersCount()

Description copied from interface: PeriodsAspectInterface

Gets the members count.

Specified by:

getMembersCount in interface PeriodsAspectInterface

Returns:

the members count

getMember

public XBRLPeriod getMember(XBRLStructuralTable table,
                   CellHeader[] header)

Description copied from interface: Aspect

Convert this aspect into a proper Member depending on the aspect type. Member can be used later to search for facts that satisfy the set of members

Specified by:

getMember in interface Aspect<XBRLPeriod>

Parameters:

table - the table

header - the header

Returns:

the member

getLabel

public java.lang.String getLabel(CellHeader ch)

Description copied from interface: MutableAspectValue

Returns a text representation of the aspect value that can be used in the GUI as the cell header.

Specified by:

getLabel in interface MutableAspectValue

Parameters:

ch - the ch

Returns:

the label