public class ExplicitDimensionLabeller extends BaseLabeller implements Labeller
A labeller for the explicit dimension aspect based upon XBRL labels and generic XBRL labels.
This labeller does not make use of label caching systems. Instead labels are obtained from the XLink relationships from explicit dimensions to XBRL 2.1 and generic labels.
Constructor and Description |
---|
ExplicitDimensionLabeller(Aspect aspect) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAspectLabel(java.lang.String locale,
java.lang.String resourceRole,
java.lang.String linkRole) |
java.lang.String |
getAspectLabelWithoutFallback(java.lang.String locale,
java.lang.String resourceRole,
java.lang.String linkRole) |
java.lang.String |
getAspectValueLabelWithoutFallback(AspectValue value,
java.lang.String locale,
java.lang.String resourceRole,
java.lang.String linkRole) |
getAspectValueLabel
duplicate, getAspect, getAspectLabelGivenLists, getAspectValueLabelGivenLists, getDomain, getStore
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
duplicate, getAspect, getAspectLabelGivenLists, getAspectValueLabel, getAspectValueLabelGivenLists, getDomain, getStore
public ExplicitDimensionLabeller(Aspect aspect) throws XBRLException
aspect
- The aspect to be a labeller for.XBRLException
public java.lang.String getAspectLabelWithoutFallback(java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole)
getAspectLabelWithoutFallback
in interface Labeller
getAspectLabelWithoutFallback
in class LabellerImpl
locale
- The locale (language code etc) of the label. Set to null if the label is not locale dependent.resourceRole
- The resource role of the XLink resource providing the label. Set to null if the label
does not depend on the resource role.linkRole
- The link role of the extended link network that is to be analysed to obtain the label. Set to
null if the label does not depend on the link role.Labeller.getAspectLabelWithoutFallback(String, String, String)
public java.lang.String getAspectLabel(java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole)
getAspectLabel
in interface Labeller
getAspectLabel
in class LabellerImpl
locale
- The locale (language code etc) of the label. Set to null if the label is not locale dependent.resourceRole
- The resource role of the XLink resource providing the label. Set to null if the label
does not depend on the resource role.linkRole
- The link role of the extended link network that is to be analysed to obtain the label. Set to
null if the label does not depend on the link role.Labeller.getAspectLabel(String, String, String)
public java.lang.String getAspectValueLabelWithoutFallback(AspectValue value, java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole)
getAspectValueLabelWithoutFallback
in interface Labeller
getAspectValueLabelWithoutFallback
in class LabellerImpl
value
- The aspect value to get a label for.locale
- The locale (language code) of the label. This can be set to
null if the label is not locale dependent.resourceRole
- The resource role of the XLink resource providing the label.
This can be set to null if the label does not depend on the
resource role.linkRole
- The link role of the extended link network that is to be
analysed to obtain the label. This can be set to null if the
label does not depend on the link role.Labeller.getAspectValueLabelWithoutFallback(AspectValue, String, String, String)