Version 12 (modified by shan, 5 years ago) (diff)


Project Preference Store

ProjectPreferenceStore is a local preference store for storing preference values related to project, e.g. preference for project's Task information. This local store caches the preference values in maps (map key is the id of the preference variable). It calls GritsPreferenceStore only if the value is not found in its map.

Major Advantages:

  1. Currently the central GritsPreferenceStore does not store any preference value in maps and reads from file each time a preference value is read. This local preference store minimizes multiple read from file by keeping a cache of preference values in memory that have been read once.
  1. Currently preference values are stored as string in the preference file. Each time a preference is read, a generic PreferenceEntity object is created by GritsPreference store. This PreferenceEntity object is later converted to more specific preference object for getting preference values. ProjectPreferenceStore reduces multiple unnecessary de-serialization of preference values from strings stored in file.
    For example, if there were four tasks, ProjectPreferenceStore would cache a list of four tasks (along with its default information) which would be otherwise each time read as string from file, unmarshalled to PreferenceEntity object and then converted to list of tasks.

These advantages are general for any similar cached-local preference store in GRITS. Plugins that would use preferences are recommended to maintain a local preference store.


ProjectPreferenceStore uses enums as parameters for getting preference values. The enum object contains important information such as preference variable name and file name. Below is a detailed description of different types of preferences that it contains and different types of values it returns.

Preferences in Project Preference store

Class diagram for project preferences

Currently there are four types of preferences for projects. Each of these preference is an enum and has all the information needed to get a preference value.

  • StringPreference - Simplest type of preference that has a string value. All the information is available in the enum object
  • Preference - Type of preference whose values are a list of string
  • ParameterizedPreference - Type of preference whose values are a list of objects of a particular class
  • IntegerPreference - A special case of ParameterizedPreference whose values are a list of integer

By using the above enum objects as parameter, the need of knowing the preference variable name or the need of knowing filename for default values (when a preference is not found in the preference file) is removed. When one of the above enum is passed as a parameter then user can get a generic SingleChoicePreference or MultiChoicePreference (or its special case MultiChoiceInteger) object.

  • SingleChoicePreference
    • characterized by a list of values and one default value (currently it only supports string values)
  • MultiChoicePreference
    • characterized by a list of selected values and a list of unselected values
  • MultiChoiceInteger
    • characterized by a list of selected integers and a list of unselected integers
    • a special case of MultiChoicePreference

Note: The simplest StringPreference is self-contained. It has a single string value that is available in the enum object itself.

ProjectPreferenceStore class

Class diagram for ProjectPreferenceStore

Preference and their values

Currently it happens to be the case that certain preference types have certain preference values. Here is the mapping of current preference type and their values:

Preference type Preference values
StringPreference -
Preference SingleChoicePreference
ParameterizedPreference MultiChoicePreference
IntegerPreference MultiChoiceInteger

Note: Currently SingleChoicePreference is not generic and only supports string preference values. If later some ParameterizedPreference have SingleChoicePreference values then SingleChoicePreference should be made a generic class.

Example Code

// string preference value
String defaultCountry = ProjectPreferenceStore.StringPreference.COUNTRY.getValue();

// single choice preference values
SingleChoicePreference actionPreference = ProjectPreferenceStore.getSingleChoicePreference(ProjectPreferenceStore.Preference.ACTION);
List<String> allActions = actionPreference.getAllValues();
String defaultAction = actionPreference.getDefaultValue();

// multi choice preference values
MultiChoicePreference<ProjectCollaborator> collaboratorPreference = ProjectPreferenceStore.getMultiChoicePreference(ProjectPreferenceStore.ParameterizedPreference.COLLABORATOR);
List<ProjectCollaborator> defaultCollaborators = collaboratorPreference.getSelectedValues();
List<ProjectCollaborator> otherCollaborators = collaboratorPreference.getOtherValues();

// multi choice integer values
MultiChoiceInteger tableColumnPreference = ProjectPreferenceStore.getMultiChoiceInteger(ProjectPreferenceStore.IntegerPreference.COLLABORATORS_TABLE);
List<Integer> visibleColumns = tableColumnPreference.getSelectedValues();

Attachments (5)

Download all attachments as: .zip