com.ihr.xbrl.om.table.definition

Class UnitAction

java.lang.Object

com.ihr.xbrl.om.table.definition.UnitAction

All Implemented Interfaces:

UnitAspectInterface, Aspect<XBRLUnit>

public class UnitAction
extends java.lang.Object
implements UnitAspectInterface

The Class UnitAction.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
UnitAction(XBRLRuleNode formula, com.ihr.xbrl.om.table.definition.UnitAspectRule.UnitOperationType code, net.sf.saxon.s9api.XdmNode actionNode) Instantiates a new unit action.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
java.lang.Object	getAspectClashIdentity() Gets the aspect clash identity.
int	getAspectType() Gets the aspect type.
com.ihr.xbrl.om.table.definition.UnitAspectRule.UnitOperationType	getCode() Gets the code.
XBRLUnit	getMember(XBRLStructuralTable table, CellHeader[] header) Gets the member.
XBRLUnit	getUnit(XBRLStructuralTable xbrlTable) Gets the unit.
void	resetNode() Reset node.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitAction

public UnitAction(XBRLRuleNode formula,
                  com.ihr.xbrl.om.table.definition.UnitAspectRule.UnitOperationType code,
                  net.sf.saxon.s9api.XdmNode actionNode)
           throws XTValidationException

Instantiates a new unit action.

Parameters:

formula - the formula

code - the code

actionNode - the action node

Throws:

XTValidationException - the XT validation exception

Method Detail

getUnit

public XBRLUnit getUnit(XBRLStructuralTable xbrlTable)

Gets the unit.

Specified by:

getUnit in interface UnitAspectInterface

Parameters:

xbrlTable - the xbrl table

Returns:

the unit

getCode

public com.ihr.xbrl.om.table.definition.UnitAspectRule.UnitOperationType getCode()

Gets the code.

Returns:

the code

getAspectClashIdentity

public java.lang.Object getAspectClashIdentity()

Gets the aspect clash identity.

Specified by:

getAspectClashIdentity in interface Aspect<XBRLUnit>

Returns:

the aspect clash identity

getAspectType

public int getAspectType()

Gets the aspect type.

Specified by:

getAspectType in interface Aspect<XBRLUnit>

Returns:

the aspect type

getMember

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

Gets the member.

Specified by:

getMember in interface Aspect<XBRLUnit>

Parameters:

table - the table

header - the header

Returns:

the member

resetNode

public void resetNode()

Reset node.

Specified by:

resetNode in interface UnitAspectInterface

Specified by:

resetNode in interface Aspect<XBRLUnit>

clear

public void clear()

Clear.

Specified by:

clear in interface Aspect<XBRLUnit>