public interface LabelCache
extends java.io.Serializable
This interface defines the capabilities of aspect label caching systems.
Label caching systems are intended to improve the performance of aspect rendering systems by determining aspect and aspect value labels in advance.
Modifier and Type | Method and Description |
---|---|
void |
cacheLabel(java.lang.Class<?> labellerClass,
java.lang.String aspectId,
java.lang.String valueId,
java.lang.String locale,
java.lang.String resourceRole,
java.lang.String linkRole,
java.lang.String label,
boolean isFallbackLabel)
Caches the given label, replacing earlier versions of such label in the cache to
ensure that there is only ever one label in the cache that matches the selection
criteria.
|
java.lang.String |
getLabel(java.lang.Class<?> labellerClass,
java.lang.String aspectId,
java.lang.String valueId,
java.lang.String locale,
java.lang.String resourceRole,
java.lang.String linkRole) |
java.lang.String |
getLabelWithoutFallback(java.lang.Class<?> labellerClass,
java.lang.String aspectId,
java.lang.String valueId,
java.lang.String locale,
java.lang.String resourceRole,
java.lang.String linkRole) |
java.lang.String getLabel(java.lang.Class<?> labellerClass, java.lang.String aspectId, java.lang.String valueId, java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole) throws XBRLException
aspectId
- the ID of the aspect - must not be null.valueId
- The id of the aspect value - must not be null.locale
- The XML language code - can be null.resourceRole
- The label resource role - can be null.linkRole
- The link role for the extended link containing the label - can be null.XBRLException
java.lang.String getLabelWithoutFallback(java.lang.Class<?> labellerClass, java.lang.String aspectId, java.lang.String valueId, java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole) throws XBRLException
aspectId
- the ID of the aspect - must not be null.valueId
- The id of the aspect value - must not be null.locale
- The XML language code - can be null.resourceRole
- The label resource role - can be null.linkRole
- The link role for the extended link containing the label - can be null.XBRLException
void cacheLabel(java.lang.Class<?> labellerClass, java.lang.String aspectId, java.lang.String valueId, java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole, java.lang.String label, boolean isFallbackLabel) throws XBRLException
aspectId
- the ID of the aspect - must not be null.valueId
- The id of the aspect value - must not be null.locale
- The XML language code - can be null.resourceRole
- The label resource role - can be null.linkRole
- The link role for the extended link containing the label - can be null.label
- The label to cache - must not be null.isFallbackLabel
- true if the label is a fallback label and false otherwise.XBRLException