org.xbrlapi.aspects
Class BaseLabeller

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

All Implemented Interfaces:

Serializable, Labeller

Direct Known Subclasses:

CachingLabeller, ConceptLabeller, EntityLabeller, ExplicitDimensionLabeller, PeriodLabeller, PeriodLabellerNaive, ScenarioLabeller, ScenarioRemainderLabeller, SegmentLabeller, SegmentRemainderLabeller, TupleLabeller, TypedDimensionLabeller, UnitLabeller

public class BaseLabeller
extends LabellerImpl
implements Labeller

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

BaseLabeller(Aspect aspect)

Method Summary

String

getAspectValueLabel(AspectValue value, String locale, URI resourceRole, URI linkRole)

Methods inherited from class org.xbrlapi.aspects.LabellerImpl

duplicate, getAspect, getAspectLabel, getAspectLabelWithoutFallback, getAspectValueLabel, getAspectValueLabelWithoutFallback, 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, getAspectLabelWithoutFallback, getAspectValueLabel, getAspectValueLabelWithoutFallback, getDomain, getStore

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

BaseLabeller

public BaseLabeller(Aspect aspect)
             throws XBRLException

Throws:

XBRLException

Method Detail

getAspectValueLabel

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

Specified by:

getAspectValueLabel in interface Labeller

Overrides:

getAspectValueLabel 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, falling back to labels generated by superclass labellers where necessary, eventually using just the aspect value ID if that is all that is available.

See Also:

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