org.xbrlapi.aspects
Class StandardAspectModelWithStoreCachingLabellers

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

All Implemented Interfaces:

Serializable, AspectModel

public class StandardAspectModelWithStoreCachingLabellers
extends StandardAspectModel
implements AspectModel

This is the same as the standard aspect model except that it also sets up the store-based caching aspect value labeller system automatically as part of the constructor.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

StandardAspectModelWithStoreCachingLabellers(Store store)

Method Summary

void	initialise() Initialises the aspects and the aspect value labellers in the aspect model.

Methods inherited from class org.xbrlapi.aspects.StandardAspectModel

getAspectValues

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, getAspectValues, getAxes, getDefaultAxis, getLabeller, hasAspect, hasAxis, hasLabeller, moveAspects, setDefaultAxis, setLabeller

Constructor Detail

StandardAspectModelWithStoreCachingLabellers

public StandardAspectModelWithStoreCachingLabellers(Store store)
                                             throws XBRLException

Parameters:

store - The data store.

Throws:

XBRLException - if a parameter is null.

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 StandardAspectModel

Throws:

XBRLException

See Also:

AspectModel.initialise()