org.xbrlapi.aspects
Class UnitLabeller

java.lang.Object
  org.xbrlapi.aspects.LabellerImpl
      org.xbrlapi.aspects.BaseLabeller
          org.xbrlapi.aspects.UnitLabeller

All Implemented Interfaces:

Serializable, Labeller

public class UnitLabeller
extends BaseLabeller
implements Labeller

A labeller for the unit aspect. This labeller attempts to use generic labels for XLink Unit resources.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.aspects.BaseLabeller

logger

Constructor Summary

UnitLabeller(Aspect aspect)

Method Summary

String	getAspectLabelWithoutFallback(String locale, URI resourceRole, URI linkRole)
String	getAspectValueLabelWithoutFallback(AspectValue value, String locale, URI resourceRole, URI linkRole)
protected String	getLabel(Measure measure, 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, getAspectLabel, 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, getAspectLabel, getAspectValueLabel, getAspectValueLabel, getDomain, getStore

Constructor Detail

UnitLabeller

public UnitLabeller(Aspect aspect)
             throws XBRLException

Parameters:

aspect - The aspect to be a labeller for.

Throws:

XBRLException

Method Detail

getLabel

protected String getLabel(Measure measure,
                          String locale,
                          URI resourceRole,
                          URI linkRole)
                   throws XBRLException

Throws:

XBRLException

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)

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)