Changes between Version 9 and Version 10 of Grits_ProjectPreferenceStore

Timestamp:

03/08/2017 08:30:02 PM (5 years ago)

Author:

shan

Comment:

--

Grits_ProjectPreferenceStore

@@ -9 +9 @@
 2. 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. [[BR]]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 local preference store in GRITS. Plugins that would be using preferences are recommended to maintain a local preference store.
+These advantages are general for any similar local preference store in GRITS. Plugins that would use preferences are recommended to maintain a local preference store.
 
 == Implementation ==
-''ProjectPreferenceStore'' works with enums and string. It takes enums as parameters and returns values in enums (single/multi-choice list).
+''ProjectPreferenceStore'' works with enums and string. It takes enums as parameters and returns values in enums (that contain single/multi-choice list).
 
 
-=== Class Diagram for various Preferences in Project Preference store ===
+=== Preferences in Project Preference store ===
 [[BR]]
 [[Image(project_preference_store.jpg, 800)]]
+Class diagram for project preferences
 [[BR]]
 
@@ -30 +31 @@
 - ''ParameterizedPreference'' - Types of preference whose values are a '''list of particular class object'''.
 
-- ''IntegerPreference'' - A special case of ''ParameterizedPreference'' whose values are a '''list of integers'''.
+- ''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 preference variable names 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 parameter then user can get a generic SingleChoicePreference or MultiChoicePreference (or its special case MultiChoiceInteger) enum object.
+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) enum object.
 
-A ''SingleChoicePreference'' is characterized by - a list of values and one default value.
+A ''SingleChoicePreference'' is characterized by - a list of values and one default value (currently it only supports string values)
 
 A ''MultiChoicePreference'' is characterized by - a list of selected values and a list of unselected values.
@@ -45 +46 @@
 [[BR]]
 [[Image(project_preference_all.png, 1300)]]
+Class diagram for project preference store
 [[BR]]