Ticket	Summary	Owner	Status	Type	Component	Priority	Effort	Importance
#340	BASE_PERSISTENCE_IMMUTABLES_R0	gogov	closed	planned_task	BASE_PERSISTENCE	3	1	0
Reported by Astea, 4 years ago.
Description	wiki page: BASE_PERSISTENCE_IMMUTABLES_R0 - effort: 1d'
Analysis_owners	peko
Analysis_reviewers	gogov
Analysis_score	3.5
Design_owners	mira, deni
Design_reviewers	meddle, meddle
Design_score	0
Imp._reviewers	meddle
Imp._score	0
Test_score	0

Analysis

Overview

This task is about persisting immutables. Generally the idea is that in Sophie 2 we have immutables and ProObjects/Properties and they have to be persisted. The goal of this task is to provide a concept for persisting the immutables.

• Immutables are not dependent on anything else.
• Their persistence is quite trivial and currently supported by the formats. These include the backgrounds, titles, sizes etc.

Task requirements

• Review persisting in the following modules:
  • => trunk/sophie2-platform/modules/org.sophie2.base.persistence
  • => trunk/sophie2-platform/modules/org.sophie2.main.model.book.format.r1/src/main/java/org/sophie2/main/model/book/format/r1
  • => trunk/sophie2-platform/modules/org.sophie2.main.model.book.format.r2/src/main/java/org/sophie2/main/model/book/format/r2
• Describe the things used for immutables.
  • formats.
  • XML tags.
  • diagram of the format.
  • etc.
• Add the new things that are to be persisted like:
  • margins
  • paddings
  • etc. (think of the other things after carefully examining the model.)
• Explain how listed immutables should be persisted with the listed tools
  • Provide a few examples
  • Accent on the usage of SharedLoader and SharedSaver
• Provide diagrams of the format that includes the tags for the persisted things.
• Create integration test for new persisted immutables.
• All important wiki content should be put in the corresponding section of a wiki page => BASE_PERSISTENCE

Task result

• wiki page
• source code

Implementation idea

• review code
• add new XML tags
• add the new immutables to the format

Related

• BASE_PERSISTENCE_COMMONS_R0
• BASE_PERSISTENCE_INTERMEDIATE_STORAGE_R0
• BASE_PERSISTENCE_FORMAT_REGISTRY_R0
• BASE_PERSISTENCE_PROPERTY_FORMAT_R0
• BASE_PERSISTENCE_FORMAT_POINT_R0

How to demo

• show the wiki page.
• run tests.

Design

^{(Describe your design here.)}

Implementation

^{(Describe and link the implementation results here (from the wiki or the repository).)}

Testing

^{(Place the testing results here.)}

Comments

^{(Write comments for this or later revisions here.)}