org.xbrlapi.aspects
Interface AspectValue

All Superinterfaces:

Serializable

All Known Implementing Classes:

BaseAspectValue, ConceptAspectValue, EntityIdentifierAspectValue, ExplicitDimensionAspectValue, LocationAspectValue, PeriodAspectValue, ScenarioAspectValue, ScenarioRemainderAspectValue, SegmentAspectValue, SegmentRemainderAspectValue, TypedDimensionAspectValue, UnitAspectValue

public interface AspectValue
extends Serializable

Author:

Geoff Shuetrim (geoff@galexy.net)

Method Summary

Aspect	getAspect()
List<AspectValue>	getChildren() This method supports aspects, such as the location aspect where values can be given a heirarchical organisation, such that an aspect value can be associated with an ordered set of children aspect values.
int	getDepth()
<F extends Fragment> F	getFragment()
String	getIdentifier()
String	getLabel()
AspectValue	getParent() This method supports aspects, such as the location aspect, where aspect values can have a heirarchical organisation, such that an aspect value can be associated with an ordered set of children aspect values.
boolean	hasParent()
boolean	isMissing()

Method Detail

getFragment

<F extends Fragment> F getFragment()
                               throws XBRLException

Returns:

the fragment expressing this aspect value. If this aspect value represents a "missing value" then the fragment returned is null.

Throws:

XBRLException - if the fragment is not of the given type.

getAspect

Aspect getAspect()

Returns:

the aspect that this is a value for.

getIdentifier

String getIdentifier()
                     throws XBRLException

Returns:

the string value of this aspect, generally, a string that uniquely indicates the value of the aspect in a human readable form.

Throws:

XBRLException - if the string value cannot be obtained.

getLabel

String getLabel()
                throws XBRLException

Returns:

The label for this aspect value.

Throws:

XBRLException

getChildren

List<AspectValue> getChildren()
                              throws XBRLException

This method supports aspects, such as the location aspect where values can be given a heirarchical organisation, such that an aspect value can be associated with an ordered set of children aspect values.

Returns:

the ordered list of child aspect values. The list is empty if there are no children aspect values.

Throws:

XBRLException

getParent

AspectValue getParent()
                      throws XBRLException

This method supports aspects, such as the location aspect, where aspect values can have a heirarchical organisation, such that an aspect value can be associated with an ordered set of children aspect values.

Returns:

the parent aspect value or null if none exists.

Throws:

XBRLException

hasParent

boolean hasParent()
                  throws XBRLException

Returns:

true if this aspect value has a parent aspect value and false otherwise.

Throws:

XBRLException

getDepth

int getDepth()
             throws XBRLException

Returns:

the number of ancestor aspect values that this aspect value has.

Throws:

XBRLException

isMissing

boolean isMissing()
                  throws XBRLException

Returns:

True if this aspect value represents a missing value.

Throws:

XBRLException