org.xbrlapi.aspects
Class StandardAspectModel

java.lang.Object
  org.xbrlapi.aspects.AspectModelImpl
      org.xbrlapi.aspects.StandardAspectModel

All Implemented Interfaces:

Serializable, AspectModel

Direct Known Subclasses:

StandardAspectModelWithMemoryCachingLabellers, StandardAspectModelWithStoreCachingLabellers

public class StandardAspectModel
extends AspectModelImpl
implements AspectModel

Standard extender

The standard extender discovers the following aspects

• @see LocationAspect
• @see ConceptAspect
• @see EntityAspect
• @see PeriodAspect
• @see SegmentAspect
• @see ScenarioAspect
• @see UnitAspect

These are the full set of aspects defined under the non-XDT aspect model in the XBRL Variables 1.0 specification. That set of standard aspects can be augmented with other aspects as required.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

StandardAspectModel(Store store)

Method Summary

Map<URI,AspectValue>	getAspectValues(Fact fact)
void	initialise() Initialises the aspects and the aspect value labellers in the aspect model.

Methods inherited from class org.xbrlapi.aspects.AspectModelImpl

addAspect, addAspect, addAspect, addAspect, axisContainsAspect, duplicate, getAspect, getAspectLabel, getAspects, getAspects, getAspectValueLabel, getAspectValueLabel, getAspectValues, getAspectValues, getAspectValues, getAspectValues, getAspectValues, getAxes, getDefaultAxis, getLabeller, getStore, hasAspect, hasAxis, hasLabeller, moveAspects, setDefaultAxis, setLabeller

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.AspectModel

addAspect, addAspect, addAspect, addAspect, axisContainsAspect, duplicate, getAspect, getAspectLabel, getAspects, getAspects, getAspectValueLabel, getAspectValueLabel, getAspectValues, getAspectValues, getAspectValues, getAspectValues, getAspectValues, getAxes, getDefaultAxis, getLabeller, hasAspect, hasAxis, hasLabeller, moveAspects, setDefaultAxis, setLabeller

Constructor Detail

StandardAspectModel

public StandardAspectModel(Store store)
                    throws XBRLException

Throws:

XBRLException

Method Detail

initialise

public void initialise()
                throws XBRLException

Description copied from interface: AspectModel

Initialises the aspects and the aspect value labellers in the aspect model. This should be called after the constructor has been run. Implementations of this class should always start by calling the initialise method of their super-class, if such a method exists. This use of initialise enables us to separate the resource intensive initialisation process from the constructor process. This can be useful if there are ways to avoid the initialisation process because of information that is already available, eg in another aspect model. In particular, this is useful for aspect model duplication.

Specified by:

initialise in interface AspectModel

Overrides:

initialise in class AspectModelImpl

Throws:

XBRLException

See Also:

AspectModel.initialise()

getAspectValues

public Map<URI,AspectValue> getAspectValues(Fact fact)
                                     throws XBRLException

Specified by:

getAspectValues in interface AspectModel

Overrides:

getAspectValues in class AspectModelImpl

Parameters:

fact - The fact to get the aspect values for.

Returns:

the map from Aspect IDs to values for those aspects, for the fact, with missing values for all aspects in the aspect model, that do not have a value for the given fact.

Throws:

XBRLException

See Also:

AspectModel.getAspectValues(Fact)