org.dvb.user

Class GeneralPreference

java.lang.Object

org.dvb.user.Preference

org.dvb.user.GeneralPreference

public final class GeneralPreference
extends Preference

This class defines a set of general preferences. These preferences are read from the receiver and each application (downloaded or not) can access them through the UserPreferenceManager.read method. The standardized preferences are "User Language", "Parental Rating", "User Name", "User Address", "User @", "Country Code", "Default Font Size", "Post Code".

When constructed, objects of this class are empty and have no values defined. Values may be added using the add methods inherited from the Preference class or by calling UserPreferenceManager.read.

The encodings of these standardized preferences are as follows.

• User Language: 3 letter ISO 639 language codes;
• Parental Rating: string using the same encoding as returned by javax.tv.service.guide.ContentRatingAdvisory.getDisplayText;
• User Name: Name of the user. This shall be in an order that is appropriate for presentation directly to the user, e.g. in Western Europe, listing the first name first and the family name last is recommended as being culturally appropriate in many locales.
• User Address: postal address of the user, may contain multiple lines separated by carriage return characters (as defined in table D-4).
• User @: e-mail address of the user in the SMTP form as defined in RFC821;
• Country Code: two letter ISO 3166-1 country code;
• Default Font Size: preferred font size for normal body text expressed in points, decimal integer value encoded as a string (26 is the default; differing size indicates a preference of different font size than usual)
• "Post Code" : no standard encoding is defined since the formats of post codes (US zip codes, German Postleitzahl) are normally country specific. The format used should be the most natural one for the country identified by the "Country Code" preference.

The preference names are treated as case-insensitive. The preference names shall be considered equal at least when the method java.lang.String.equalsIgnoreCase() returns true for the strings when the locale "EN.UK" is used. Depending on the locale used in the implementation, implementations are allowed to consider equal also other upper and lower case character pairs in addition to those defined by the "EN.UK" locale.

The standardized preference names in the present document shall only use such letters where the upper and lower case characters are recognized by the "EN.UK" locale. Since the "Post Code" preference forms part of the "User Address" preference, successful calls to UserPreferenceManager.write(..) for a GeneralPreference("Post Code") shall modify the "User Address" preference. Hence UserPreferenceChangeEvents shall be generated for both "Post Code" and "User Address" in this specific situation. Successful calls to UserPreferenceManager.write(...) for a GeneralPreference("User Address") shall generate a UserPreferenceChangeEvent for "Post Code" if and only if the post code part of the address changes.

Constructor Summary

Constructors

Constructor and Description
GeneralPreference(String name) Constructs a GeneralPreference object.

Method Summary

Methods inherited from class org.dvb.user.Preference

add, add, add, getFavourites, getMostFavourite, getName, getPosition, hasValue, remove, removeAll, setMostFavourite, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralPreference

public GeneralPreference(String name)
                  throws IllegalArgumentException

Constructs a GeneralPreference object. A general preference maps a preference name to a list of strings.

Parameters:

name - the general preference name.

Throws:

IllegalArgumentException - if the preference's name is not supported.