Personal tools
You are here: Home Community Help Center Reference Manuals RiskAnalytics Developer's Guide Setting display names Convention and internationalization for display names

5.2. Convention and internationalization for display names

Up one level
How to use internationalization and labeling for models, components and strategies.

PillarOne RiskAnalytics offers a combination of naming conventions and internationalization methods to offer the utmost flexibility in setting display names. Meaningful display names are very important, in particular, if the model builders are not the same group of people as the users.

To create the display name of a component or its parameters in a model, Risk Analytics performs the following steps:

Rule 1:  Model specific display names

Search the component’s or parameter’s path in the model resource bundle.

The model resource bundle is in the same package (directory) as the model. For the CapitalEagleModel the file names look like this:

  • CapitalEagleModelResources.properties
  • CapitalEagleModelResources_de.properties (for German display names)
  • CapitalEagleModelResources_fr.properties (for French display names)
  • ...
The key is the path in the model. For the Earth Quake Generator in the Capital Eagle Model a key/value pair looks like this:
property.subClaimsGenerator.subEQGenerator=EQ Generator

Note that the default naming schema would yield e q generator. This rule serves the purpose to give components and parameters model specific names.
If no information is found, then apply Rule 2 if it is a parameter else apply Rule 3.

Rule 2: Internationalization of parameters in strategy types

If it is a parameter in a strategy type, then search the parameter name in the corresponding strategy type resource bundle. This resource bundle is located in the same package (i.e. directory) as the strategy type definition. For claims generators it is

org.pillarone.modelling.domain.generators.claims.

Example: German display names of the reinsurance contract type parameters it is

#this is the display name of the strategy
displayName=Vertragsparameter 

type=Typ
type.QUOTASHARE=Quote
type.QUOTASHAREAAL=Quote mit Jahreshaftungslimite
type.SURPLUS=Summenexzedent
type.WXL=Schadenexzedent
type.CXL=Schadenexzedent je Schadenereignis
type.STOPLOSS=Jahresüberschaden-RV
type.TRIVIAL=keine Deckung
type.AggregateXL=Schadenexzedent für gemeinsame Rechnung

quotaShare=Quote
commission=Provision
coveredByReinsurer=akzeptierter Anteil

premiumBase=Prämienbasis
premiumBase.ABSOLUTE=absolute

premiumBase.NUMBER_OF_POLICIES=Anzahl Policen

Never mind if you don’t speak German ;-) You can write the property files for any language.

Note: The parameter “type” is a combobox and hence, its values have to be internationalized using the syntax type.*.

Rule 1 can be used to overwrite some parameter names only for a specific model without having to change the usual internationalization.

If nothing is found, then apply Rule 3.

Rule 3:  Component-centric display names

Search the display name of the component of a parameter of this component in the component’s resource bundle. The component resource bundle is in the same directory (package) as the component. It can contain 3 different types of values:

  • The component’s display name (key: displayName)
  • parameter properties
  • out channel properties which are used in the result view

This could look as follows:

#this is the display name of the component
displayName=Rückversicherungsvertrag

#parameters
parmContractStrategy=Vertragstyp
parmInuringPriority=Reihenfolge

#outchannels
outCoveredClaims=Schäden, zediert
outUncoveredClaims=Schäden, netto
outCoverUnderwritingInfo=Zeichnungsinformation, zediert
outNetAfterCoverUnderwritingInfo=Zeichnungsinformation, netto

If nothing is found and the component has been derived from another component (its super class), then the same is done again for the super class.

Component-centric display names are typically set by a developer if he thinks that the default display names won’t be understandable.

Component-centric display names are over-written by display names set in Rule 2 and 1.

If no display name is found, then apply the default naming schema

Rule 4: Default naming schema