org.xbrlapi.xdt.aspects
Class ScenarioRemainderAspectValue

java.lang.Object
  org.xbrlapi.aspects.AspectValueImpl
      org.xbrlapi.xdt.aspects.ScenarioRemainderAspectValue

All Implemented Interfaces:

Serializable, AspectHandler, AspectValue

public class ScenarioRemainderAspectValue
extends AspectValueImpl
implements AspectValue

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

ScenarioRemainderAspectValue()
Missing aspect value constructor.

ScenarioRemainderAspectValue(Scenario scenario)
If the scenario contains no non-XDT content then this aspect value is missing.

Method Summary

URI	getAspectId()
List<Element>	getChildren()
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

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

ScenarioRemainderAspectValue

public ScenarioRemainderAspectValue()

Missing aspect value constructor.

ScenarioRemainderAspectValue

public ScenarioRemainderAspectValue(Scenario scenario)
                             throws XBRLException

If the scenario contains no non-XDT content then this aspect value is missing.

Parameters:

scenario - The scenario fragment.

Throws:

XBRLException

Method Detail

getChildren

public List<Element> getChildren()

Returns:

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

getAspectId

public URI 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 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.