org.xbrlapi.aspects

Class LocationAspectValue

java.lang.Object

org.xbrlapi.aspects.AspectValueImpl

org.xbrlapi.aspects.LocationAspectValue

All Implemented Interfaces:

java.io.Serializable, AspectHandler, AspectValue

public class LocationAspectValue
extends AspectValueImpl
implements AspectValue

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocationAspectValue() Missing aspect value constructor
LocationAspectValue(java.lang.String index)
LocationAspectValue(java.lang.String parentFactIndex, java.lang.String index)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAspectId()
java.lang.String	getFactIndex()
java.lang.String	getId() This method must be implemented by each concrete aspect value class.
java.lang.String	getParentFactIndex()
boolean	isMissing() There is no such thing as a missing location aspect value.
boolean	isRootLocation()

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

LocationAspectValue

public LocationAspectValue()

Missing aspect value constructor

LocationAspectValue

public LocationAspectValue(java.lang.String index)
                    throws XBRLException

Parameters:

index - The index of the fact.

Throws:

XBRLException - if the parameter is null.

LocationAspectValue

public LocationAspectValue(java.lang.String parentFactIndex,
                   java.lang.String index)
                    throws XBRLException

Parameters:

parentFactIndex - String equal to the index of the parent fact. Only use this constructor for facts that are children of tuple facts.

index - The index of the fact.

Throws:

XBRLException - if a parameter is null.

Method Detail

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.

See Also:

AspectValue.getId()

getAspectId

public java.lang.String getAspectId()

Specified by:

getAspectId in interface AspectHandler

Returns:

the aspect itself

See Also:

AspectHandler.getAspectId()

isMissing

public boolean isMissing()

There is no such thing as a missing location aspect value.

Specified by:

isMissing in interface AspectValue

Returns:

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

See Also:

AspectValue.isMissing()

getFactIndex

public java.lang.String getFactIndex()

Returns:

the index of the fact fragment that this is a location for.

isRootLocation

public boolean isRootLocation()

Returns:

true if this location is for a fact that is a child of an XBRL instance and false if this location is for a fact that is a child of a tuple fact.

getParentFactIndex

public java.lang.String getParentFactIndex()
                                    throws XBRLException

Returns:

the index of the parent tuple fact for facts that are children of tuples.

Throws:

XBRLException - if the fact is a child of an XBRL instance rather than a tuple fact.