Module org.opengis.geoapi

Package org.opengis.annotation

Class ResourceBundles

Object

ResourceBundles

public final class ResourceBundles
extends Object

Localized resources for elements from OGC/ISO standards. This class provides ResourceBundle or Properties objects in which keys can have the following patterns:

• <class>
• <class>.<member>

where <class> and <member> are the UML identifiers as specified in the OGC/ISO standards. Those identifiers for GeoAPI interfaces and methods are given by UML.identifier().

Example

The "CI_RoleCode.principalInvestigator" key is associated to the following values:

• Locale.ENGLISH
  • CodeList: Principal investigator
  • Description: Key party responsible for gathering information and conducting research.
• Locale.FRENCH
  • CodeList: Maître d’œuvre principal
  • Description: Acteur qui a assuré la réalisation de la ressource, éventuellement en faisant appel à des co-traitants ou des sous-traitants.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
static Properties	classIndex()	Returns the mapping from UML identifiers to Java classes.
static ResourceBundle	codeLists(Locale locale)	Returns the localized resources for the code list labels.
static ResourceBundle	descriptions(Locale locale)	Returns the localized resources for the property descriptions.

Methods inherited from class java.lang.Object

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

Method Details

codeLists

public static ResourceBundle codeLists(Locale locale)

Returns the localized resources for the code list labels. Keys are <class> or <class>.<member> strings where <class> and <member> are UML identifiers as specified in the OGC/ISO standards. Values are human-readable texts in the specified locale if available, or in English as a fallback.

Example

codeLists.getString("CI_RoleCode.principalInvestigator") returns Principal investigator if the specified locale is Locale.ENGLISH, or Maître d’œuvre principal if the specified locale is Locale.FRENCH.

Parameters:

locale - the locale for which a resource bundle is desired, or null for the default locale.

Returns:

localized texts for the specified or default locale.

descriptions

public static ResourceBundle descriptions(Locale locale)

Returns the localized resources for the property descriptions. Keys are <class> or <class>.<member> strings where <class> and <member> are UML identifiers as specified in the OGC/ISO standards. Values are human-readable texts in the specified locale if available, or in English as a fallback.

Example

descriptions.getString("CI_RoleCode.principalInvestigator") returns Key party responsible for gathering information and conducting research. if the specified locale is Locale.ENGLISH, or Acteur qui a assuré la réalisation de la ressource, éventuellement en faisant appel à des co-traitants ou des sous-traitants. if the specified locale is Locale.FRENCH.

Parameters:

locale - the locale for which a resource bundle is desired, or null for the default locale.

Returns:

localized texts for the specified or default locale.

classIndex

public static Properties classIndex()
                             throws IOException

Returns the mapping from UML identifiers to Java classes. The returned map is the converse of UML.identifier().

Examples

classIndex.getString("CRS") returns "org.opengis.referencing.crs.CoordinateReferenceSystem".

Performance note

This method loads the resources in a new Properties instance every time that this method is invoked, because Properties is a mutable object. Callers should invoke this method only once and cache the map.

Returns:

mapping from UML identifiers to Java classes in a new Properties instance.

Throws:

IOException - if the properties cannot be loaded.

See Also:

• UML.identifier()