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

Author:

Ignacio

Field Summary

Fields inherited from class com.ihr.xbrl.om.formula.aspects.CommonAspectRule

ALLDIMENSIONALASPECTS, ALLNONDIMENSIONALASPECTS, ANY, COMPLETESCENARIO, COMPLETESEGMENT, CONCEPT, DIMENSION, ENTITYIDENTIFIER, LOCATION, NONE, NONXDTSCENARIO, NONXDTSEGMENT, PERIOD, UNIT, VALUE

Constructor Summary

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

Method Summary

XMLElementDefinition	getConcept(XPathHelper xph) Returns the calculated concept for this aspect
javax.xml.namespace.QName	getDimension()
XBRLEntity	getEntity(XPathHelper xph)
XBRLContext	getLastEvaluatedContext()
XBRLFactsList	getLocation(XBRLInstance instance, XPathHelper xph) Returns the location for a new item or tuple
XBRLPeriod	getPeriod(XPathHelper xph)
XBRLItem.PeriodType	getPeriodType(XBRLItem item) Returns a constant identifying either XBRLItem.DURATION or XBRLItem.INSTANT
XBRLUnit	getUnit(XPathHelper xph)
boolean	isStaticConcept() Returns true if the evaluation of the concept does not requires access to dynamic content.
void	resolve(XMLElementDefinition el, FContext fc, XPathHelper xph, javax.xml.namespace.QName dimName) Resolve one dimension in the appropriate dimension container
void	updateDimensionsContainer(FContext fctx, XPathHelper xph, boolean bIsOcc)

Methods inherited from class com.ihr.xbrl.om.formula.aspects.CommonAspectRule

getAspectsText

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAspectRule

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

Parameters:

aspect -

formula -

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

Throws:

XFValidationException

Method Detail

getConcept

public XMLElementDefinition getConcept(XPathHelper xph)
                                throws XFValidationException

Description copied from interface: ConceptAspectInterface

Returns the calculated concept for this aspect

Specified by:

getConcept in interface ConceptAspectInterface

Returns:

a QName

Throws:

XFValidationException

isStaticConcept

public boolean isStaticConcept()

Description copied from interface: ConceptAspectInterface

Returns true if the evaluation of the concept does not requires access to dynamic content.

Specified by:

isStaticConcept in interface ConceptAspectInterface

Returns:

boolean

getPeriodType

public XBRLItem.PeriodType getPeriodType(XBRLItem item)

Description copied from interface: PeriodAspectInterface

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

Specified by:

getPeriodType in interface PeriodAspectInterface

getEntity

public XBRLEntity getEntity(XPathHelper xph)
                     throws XFValidationException

Specified by:

getEntity in interface EntityIdentifierAspectInterface

Returns:

Throws:

XFValidationException

getPeriod

public XBRLPeriod getPeriod(XPathHelper xph)
                     throws XFValidationException

Specified by:

getPeriod in interface PeriodAspectInterface

Returns:

Throws:

XFValidationException

getUnit

public XBRLUnit getUnit(XPathHelper xph)
                 throws XFValidationException

Specified by:

getUnit in interface UnitAspectInterface

Returns:

Throws:

XFValidationException

updateDimensionsContainer

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

Specified by:

updateDimensionsContainer in interface ContextComponentRuleInterface

Throws:

XFValidationException

getLastEvaluatedContext

public XBRLContext getLastEvaluatedContext()

Specified by:

getLastEvaluatedContext in interface EntityIdentifierAspectInterface

resolve

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

Description copied from interface: DimensionAspectInterface

Resolve one dimension in the appropriate dimension container

Specified by:

resolve in interface DimensionAspectInterface

Parameters:

el - This is the concept definition for which the dimension is going to be resolved

Throws:

XFValidationException

getDimension

public javax.xml.namespace.QName getDimension()

Specified by:

getDimension in interface DimensionAspectInterface

Returns:

getLocation

public XBRLFactsList getLocation(XBRLInstance instance,
                                 XPathHelper xph)

Description copied from interface: LocationAspectInterface

Returns the location for a new item or tuple

Specified by:

getLocation in interface LocationAspectInterface

Parameters:

instance - the instance that is being constructed