org.xbrlapi.aspects
Interface LabelHandler

public interface LabelHandler

Author:

Geoff Shuetrim (geoff@galexy.net)

Method Summary

String	getLabel() If the label is not in the cache then implementations of this method can elect to inject the label into the cache for future usage.
String	getLabel(List<String> languages) If the label is not in the cache then implementations of this method can elect to inject the label into the cache for future usage.
String	getLabel(List<String> languages, List<URI> roles)
boolean	hasLabel()
boolean	hasLabel(List<String> languages)
boolean	hasLabel(List<String> languages, List<URI> roles)

Method Detail

hasLabel

boolean hasLabel()
                 throws XBRLException

Returns:

true if the cache contains a suitable label and false otherwise.

Throws:

XBRLException

getLabel

String getLabel()
                throws XBRLException

If the label is not in the cache then implementations of this method can elect to inject the label into the cache for future usage.

Returns:

The label based upon default locale and role selections or null if none exists.

Throws:

XBRLException

hasLabel

boolean hasLabel(List<String> languages)
                 throws XBRLException

Parameters:

languages - A list of label language codes, from most preferred (first in the list) to least preferred (last in the list).

Returns:

true if there is a suitable label and false otherwise.

Throws:

XBRLException

getLabel

String getLabel(List<String> languages)
                throws XBRLException

If the label is not in the cache then implementations of this method can elect to inject the label into the cache for future usage.

Parameters:

languages - A list of label language codes, from most preferred (first in the list) to least preferred (last in the list).

Returns:

The label based upon default locale and role selections or null if none exists.

Throws:

XBRLException

hasLabel

boolean hasLabel(List<String> languages,
                 List<URI> roles)
                 throws XBRLException

Parameters:

languages - A list of label language codes, from most preferred (first in the list) to least preferred (last in the list).

roles - A list of label roles, from most preferred (first in the list) to least preferred (last in the list).

Returns:

true if there is a suitable label and false otherwise.

Throws:

XBRLException

getLabel

String getLabel(List<String> languages,
                List<URI> roles)
                throws XBRLException

Parameters:

languages - A list of label language codes, from most preferred (first in the list) to least preferred (last in the list).

roles - A list of label roles, from most preferred (first in the list) to least preferred (last in the list).

Returns:

The label based upon default locale and role selections or null if none exists.

Throws:

XBRLException