public class LocationAspectValue extends AspectValueImpl implements AspectValue
Constructor and Description |
---|
LocationAspectValue()
Missing aspect value constructor
|
LocationAspectValue(java.lang.String index) |
LocationAspectValue(java.lang.String parentFactIndex,
java.lang.String index) |
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() |
equals, hashCode
public LocationAspectValue()
public LocationAspectValue(java.lang.String index) throws XBRLException
index
- The index of the fact.XBRLException
- if the parameter is null.public LocationAspectValue(java.lang.String parentFactIndex, java.lang.String index) throws XBRLException
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.XBRLException
- if a parameter is null.public java.lang.String getId()
AspectValue
getId
in interface AspectValue
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.AspectValue.getId()
public java.lang.String getAspectId()
getAspectId
in interface AspectHandler
AspectHandler.getAspectId()
public boolean isMissing()
isMissing
in interface AspectValue
AspectValue.isMissing()
public java.lang.String getFactIndex()
public boolean isRootLocation()
public java.lang.String getParentFactIndex() throws XBRLException
XBRLException
- if the fact is a child of an XBRL instance
rather than a tuple fact.