com.ihr.xbrl.om.formula.aspects

Class DefaultAspectRule

java.lang.Object

com.ihr.xbrl.om.formula.aspects.CommonAspectRule

com.ihr.xbrl.om.formula.aspects.DefaultAspectRule

All Implemented Interfaces:

ConceptAspectInterface, ContextComponentRuleInterface, DimensionAspectInterface, EntityIdentifierAspectInterface, LocationAspectInterface, PeriodAspectInterface, UnitAspectInterface

public class DefaultAspectRule
extends CommonAspectRule
implements ConceptAspectInterface, EntityIdentifierAspectInterface, PeriodAspectInterface, UnitAspectInterface, ContextComponentRuleInterface, DimensionAspectInterface, LocationAspectInterface

The Class DefaultAspectRule.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
DefaultAspectRule(Aspect aspect, XBRLFormula formula, net.sf.saxon.s9api.XdmNode aspectNode, int type) Instantiates a new default aspect rule.

Method Summary

Modifier and Type	Method and Description
XMLElementDefinition	getConcept() Gets the concept.
javax.xml.namespace.QName	getDimension() Gets the dimension.
XBRLEntity	getEntity() Gets the entity.
XBRLContext	getLastEvaluatedContext() Gets the last evaluated context.
XBRLFactsList	getLocation(XBRLInstance instance) Gets the location.
XBRLPeriod	getPeriod() Gets the period.
XBRLItem.PeriodType	getPeriodType(XBRLItem item) Gets the period type.
javax.xml.namespace.QName	getSource() Access to the source from other classes.
XBRLUnit	getUnit() Gets the unit.
boolean	isStaticConcept() Checks if is static concept.
void	resetLastEvaluated() Reset last evaluated.
void	resolve(XMLElementDefinition el, FContext fc, javax.xml.namespace.QName dimName) Resolve.
void	updateDimensionsContainer(FContext fctx, boolean bIsOcc) Update dimensions container.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAspectRule

public DefaultAspectRule(Aspect aspect,
                         XBRLFormula formula,
                         net.sf.saxon.s9api.XdmNode aspectNode,
                         int type)
                  throws XFValidationException

Instantiates a new default aspect rule.

Parameters:

aspect - the aspect

formula - the formula

aspectNode - the aspect node

type - this is either TYPED or EXPLICIT but only when DIMENSION is the aspect

Throws:

XFValidationException - the XF validation exception

Method Detail

getConcept

public XMLElementDefinition getConcept()
                                throws XFValidationException

Gets the concept.

Specified by:

getConcept in interface ConceptAspectInterface

Returns:

the concept

Throws:

XFValidationException - the XF validation exception

isStaticConcept

public boolean isStaticConcept()

Checks if is static concept.

Specified by:

isStaticConcept in interface ConceptAspectInterface

Returns:

true, if is static concept

getPeriodType

public XBRLItem.PeriodType getPeriodType(XBRLItem item)

Gets the period type.

Specified by:

getPeriodType in interface PeriodAspectInterface

Parameters:

item - the item

Returns:

the period type

getEntity

public XBRLEntity getEntity()
                     throws XFValidationException

Gets the entity.

Specified by:

getEntity in interface EntityIdentifierAspectInterface

Returns:

the entity

Throws:

XFValidationException - the XF validation exception

getPeriod

public XBRLPeriod getPeriod()
                     throws XFValidationException

Gets the period.

Specified by:

getPeriod in interface PeriodAspectInterface

Returns:

the period

Throws:

XFValidationException - the XF validation exception

getUnit

public XBRLUnit getUnit()
                 throws XFValidationException

Gets the unit.

Specified by:

getUnit in interface UnitAspectInterface

Returns:

the unit

Throws:

XFValidationException - the XF validation exception

updateDimensionsContainer

public void updateDimensionsContainer(FContext fctx,
                                      boolean bIsOcc)
                               throws XFValidationException

Update dimensions container.

Specified by:

updateDimensionsContainer in interface ContextComponentRuleInterface

Parameters:

fctx - the fctx

bIsOcc - the b is occ

Throws:

XFValidationException - the XF validation exception

getLastEvaluatedContext

public XBRLContext getLastEvaluatedContext()

Gets the last evaluated context.

Specified by:

getLastEvaluatedContext in interface EntityIdentifierAspectInterface

Returns:

the last evaluated context

resetLastEvaluated

public void resetLastEvaluated()

Reset last evaluated.

Specified by:

resetLastEvaluated in interface EntityIdentifierAspectInterface

resolve

public void resolve(XMLElementDefinition el,
                    FContext fc,
                    javax.xml.namespace.QName dimName)
             throws XFValidationException

Resolve.

Specified by:

resolve in interface DimensionAspectInterface

Parameters:

el - the el

fc - the fc

dimName - the dim name

Throws:

XFValidationException - the XF validation exception

getDimension

public javax.xml.namespace.QName getDimension()

Gets the dimension.

Specified by:

getDimension in interface DimensionAspectInterface

Returns:

the dimension

getLocation

public XBRLFactsList getLocation(XBRLInstance instance)

Gets the location.

Specified by:

getLocation in interface LocationAspectInterface

Parameters:

instance - the instance

Returns:

the location

getSource

public javax.xml.namespace.QName getSource()

Access to the source from other classes.

Specified by:

getSource in interface EntityIdentifierAspectInterface

Returns:

QName