de.aristaflow.adept2.model.common

Class LocalisedCheckReport.LocalisedReportEntry

java.lang.Object

de.aristaflow.adept2.util.CheckReport.ReportEntry

de.aristaflow.adept2.model.common.LocalisedCheckReport.LocalisedReportEntry

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

LocalisedCheckReport

public static class LocalisedCheckReport.LocalisedReportEntry
extends CheckReport.ReportEntry

A report entry extension providing localised messages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.util.Locale,java.lang.String>	localisedMessage The localised message of this report entry.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalisedReportEntry(int entryNumber, java.lang.String checkID, CheckReport.ResultType reportEntryType, java.lang.String defaultMessage, java.util.Map<java.util.Locale,java.lang.String> localisedMessage, java.net.URI... affectedElements) Constructs the report entry with the designated parameters.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.util.Locale,java.lang.String>	getAllMessages() Gets the localised message(s) for all (preferred) locales.
java.lang.String	getMessage(java.util.Collection<java.util.Locale> locales) Gets the localised message of the check report entry corresponding to the designated locales preferring previous locales.
java.lang.String	getMessage(java.util.Locale locale) Gets the localised message of the check report entry corresponding to the designated locale or one of its fallback.

Methods inherited from class de.aristaflow.adept2.util.CheckReport.ReportEntry

getAffectedADEPT2ProcessElements, getCheckID, getEntryNumber, getMessage, getReportEntryType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

localisedMessage

protected final java.util.Map<java.util.Locale,java.lang.String> localisedMessage

The localised message of this report entry.

Constructor Detail

LocalisedReportEntry

protected LocalisedReportEntry(int entryNumber,
                               java.lang.String checkID,
                               CheckReport.ResultType reportEntryType,
                               java.lang.String defaultMessage,
                               java.util.Map<java.util.Locale,java.lang.String> localisedMessage,
                               java.net.URI... affectedElements)

Constructs the report entry with the designated parameters.

Parameters:

entryNumber - the number of this entry in the report

checkID - the check which created the entry

reportEntryType - the type of the entry

defaultMessage - The default message used if no corresponding localisation is found.

localisedMessage - The localised message for the corresponding locale. This should contain all preferred locales (or at least the corresponding fallbacks) of the check report.

affectedElements - the process elements affected by this entry

Method Detail

getAllMessages

public java.util.Map<java.util.Locale,java.lang.String> getAllMessages()

Gets the localised message(s) for all (preferred) locales. This does not consider fallback locales. You should usually use getMessage(Locale) or getMessage(Collection).

Returns:

The localised message(s) for all (preferred) locales.

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Gets the localised message of the check report entry corresponding to the designated locale or one of its fallback.

Parameters:

locale - The locale for which to get the message of the check report entry.

Returns:

The localised message of the check report entry.

getMessage

public java.lang.String getMessage(java.util.Collection<java.util.Locale> locales)

Gets the localised message of the check report entry corresponding to the designated locales preferring previous locales.

Parameters:

locales - The locales for which to get the message of the check report entry with the first locale having the highest priority and the last locale the least priority.

Returns:

The localised message of the check report entry.