org.xbrlapi.aspects

Class ScenarioAspect

java.lang.Object

org.xbrlapi.aspects.AspectImpl

org.xbrlapi.aspects.ScenarioAspect

All Implemented Interfaces:

java.io.Serializable, Aspect

public class ScenarioAspect
extends AspectImpl
implements Aspect

Scenario aspect details

Scenario aspects capture information in the context scenario.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID The URI uniquely identifying this concept aspect.

Constructor Summary

Constructors

Constructor and Description
ScenarioAspect(Domain domain)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId()
ScenarioAspectValue	getMissingValue()
ScenarioAspectValue	getValue(Context context)
ScenarioAspectValue	getValue(Fact fact)
ScenarioAspectValue	getValue(Scenario scenario)

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue, isExtensible

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.Aspect

getDomain, getValue, isExtensible

Field Detail

ID

public static java.lang.String ID

The URI uniquely identifying this concept aspect.

Constructor Detail

ScenarioAspect

public ScenarioAspect(Domain domain)
               throws XBRLException

Parameters:

domain - The domain for this aspect.

Throws:

XBRLException

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Aspect

Returns:

the URI that identifies this aspect.

See Also:

Aspect.getId()

getValue

public ScenarioAspectValue getValue(Fact fact)
                             throws XBRLException

Specified by:

getValue in interface Aspect

Parameters:

fact - The fact to get the aspect value for.

Returns:

a value for this aspect for the given fact.

Throws:

XBRLException

See Also:

Aspect.getValue(Fact)

getValue

public ScenarioAspectValue getValue(Context context)
                             throws XBRLException

Specified by:

getValue in interface Aspect

Overrides:

getValue in class AspectImpl

Parameters:

context - The context to get the aspect value from.

Returns:

the aspect value for the context or the missing aspect value if the context does not define a value for the aspect.

Throws:

XBRLException

See Also:

Aspect.getValue(Context)

getValue

public ScenarioAspectValue getValue(Scenario scenario)
                             throws XBRLException

Parameters:

scenario - The context scenario

Returns:

the scenario aspect value.

Throws:

XBRLException

getMissingValue

public ScenarioAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()