org.xbrlapi.aspects

Class ScenarioAspectValue

java.lang.Object

org.xbrlapi.aspects.AspectValueImpl

org.xbrlapi.aspects.ScenarioAspectValue

All Implemented Interfaces:

java.io.Serializable, AspectHandler, AspectValue

public class ScenarioAspectValue
extends AspectValueImpl
implements AspectValue

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScenarioAspectValue() Missing aspect value constructor.
ScenarioAspectValue(Scenario scenario)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAspectId()
java.util.List<org.w3c.dom.Element>	getChildren()
java.lang.String	getId() This method must be implemented by each concrete aspect value class.
boolean	isMissing() This method must be implemented by each concrete aspect value class.

Methods inherited from class org.xbrlapi.aspects.AspectValueImpl

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScenarioAspectValue

public ScenarioAspectValue()

Missing aspect value constructor.

ScenarioAspectValue

public ScenarioAspectValue(Scenario scenario)
                    throws XBRLException

Parameters:

scenario - The scenario fragment.

Throws:

XBRLException

Method Detail

getChildren

public java.util.List<org.w3c.dom.Element> getChildren()

Returns:

the list of child elements in the segment, in document order.

getAspectId

public java.lang.String getAspectId()

Specified by:

getAspectId in interface AspectHandler

Returns:

the aspect itself

See Also:

AspectHandler.getAspectId()

isMissing

public boolean isMissing()

Description copied from interface: AspectValue

This method must be implemented by each concrete aspect value class.

Specified by:

isMissing in interface AspectValue

Returns:

true if this aspect value represents a missing value and false otherwise.

See Also:

AspectValue.isMissing()

getId

public java.lang.String getId()

Description copied from interface: AspectValue

This method must be implemented by each concrete aspect value class. The identifier associated with a "missing-value" aspect value is implementation dependent. You cannot assume that it will be the empty string or a null value.

Specified by:

getId in interface AspectValue

Returns:

the string value that uniquely identifies this aspect value, for a given aspect. This value is not generally human readable. The label handler methods are more suitable for obtaining human readable representations of aspect values. A unique value for missing aspect values needs to be generated by implementations of this method.