org.xbrlapi.aspects
Class ScenarioLabeller

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

All Implemented Interfaces:

Serializable, Labeller

public class ScenarioLabeller
extends BaseLabeller
implements Labeller

A labeller for the scenario aspect. This labeller ignores link role and resource role values.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.aspects.BaseLabeller

logger

Constructor Summary

ScenarioLabeller(Aspect aspect)

Method Summary

String

getAspectLabelWithoutFallback(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, 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, getAspectValueLabel, getAspectValueLabel, getAspectValueLabelWithoutFallback, getDomain, getStore

Constructor Detail

ScenarioLabeller

public ScenarioLabeller(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)