org.xbrlapi.xdt.aspects
Class ExplicitDimensionLabeller

java.lang.Object
  org.xbrlapi.aspects.LabellerImpl
      org.xbrlapi.aspects.BaseLabeller
          org.xbrlapi.xdt.aspects.ExplicitDimensionLabeller

All Implemented Interfaces:

Serializable, Labeller

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.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.aspects.BaseLabeller

logger

Constructor Summary

ExplicitDimensionLabeller(Aspect aspect)

Method Summary

String	getAspectLabel(String locale, URI resourceRole, URI linkRole)
String	getAspectLabelWithoutFallback(String locale, URI resourceRole, URI linkRole)
String	getAspectValueLabelWithoutFallback(AspectValue value, String locale, URI resourceRole, URI linkRole)

Methods inherited from class org.xbrlapi.aspects.BaseLabeller

getAspectValueLabel

Methods inherited from class org.xbrlapi.aspects.LabellerImpl

duplicate, getAspect, getAspectValueLabel, getDomain, getStore

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.Labeller

duplicate, getAspect, getAspectValueLabel, getAspectValueLabel, getDomain, getStore

Constructor Detail

ExplicitDimensionLabeller

public ExplicitDimensionLabeller(Aspect aspect)
                          throws XBRLException

Parameters:

aspect - The aspect to be a labeller for.

Throws:

XBRLException

Method Detail

getAspectLabelWithoutFallback

public String getAspectLabelWithoutFallback(String locale,
                                            URI resourceRole,
                                            URI linkRole)

Specified by:

getAspectLabelWithoutFallback in interface Labeller

Overrides:

getAspectLabelWithoutFallback in class LabellerImpl

Parameters:

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.

Returns:

the label for the aspect based upon the given parameters or null if no such label exists.

See Also:

Labeller.getAspectLabelWithoutFallback(String, URI, URI)

getAspectLabel

public String getAspectLabel(String locale,
                             URI resourceRole,
                             URI linkRole)

Specified by:

getAspectLabel in interface Labeller

Overrides:

getAspectLabel in class LabellerImpl

Parameters:

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.

Returns:

the label for the aspect based upon the given parameters, falling back to labels generated by superclass labellers where necessary, eventually using just the aspect ID if that is all that is available.

See Also:

Labeller.getAspectLabel(String, URI, URI)

getAspectValueLabelWithoutFallback

public String getAspectValueLabelWithoutFallback(AspectValue value,
                                                 String locale,
                                                 URI resourceRole,
                                                 URI linkRole)

Specified by:

getAspectValueLabelWithoutFallback in interface Labeller

Overrides:

getAspectValueLabelWithoutFallback in class LabellerImpl

Parameters:

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.

Returns:

the label for the aspect value based upon the given parameters, without falling back to the label obtained by the superclass, if no label can be obtained. If no label is obtained, a value of null is returned.

See Also:

Labeller.getAspectValueLabelWithoutFallback(AspectValue, String, URI, URI)