Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

Error: Macro TicketQuery(summary=GROUP_FILE_ACCESSES_PERSISTENCE_R0, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|) failed

current transaction is aborted, commands ignored until end of transaction block

Analysis

Overview

This task is the second task of the GROUP_RESOURCE_MODEL_REDESIGN_R0. Tasks goal is to present the file resource accesses and working logic for persistence. Its also part of the refactoring of the model since all persisters should be refactored as well.

Task requirements

• Complete and stable design of the mem and file accesses hierarchy.
• Implementation of persistence keys and options.
• Providing logic for serialization of changes and model.
• Refactoring of all current persisters and writing more for the new model objects like changes and immlist.

Task result

The result will be source code and documentation of aspects of the new designs that were too specific to be part of the major redesign documentation.

Implementation idea

• Read the GROUP_RESOURCE_MODEL_REDESIGN_R0 and GROUP_MEM_RESOURCES_MODEL_R0

Related

GROUP_RESOURCE_MODEL_REDESIGN_R0
GROUP_MEM_RESOURCES_MODEL_R0
GROUP_PERSISTENCE_R0

How to demo

Save and load a sophie 2 book one afterhow the new hierarchy and demonstrate that all of the tests work.

Design

Make class PersistKey that is going to be used as a type-save key for mapping different PersistenceOptions. It should have id, value class and default value. All needed keys will be defined in PersistenceUtil. The persistence Mode (save or load) will be kept by the PersistKey<Mode> MODE.

The FileAccess save method should take the PersistenceOptions as argument and if they are null to persist with default PersistenceOptions for save (only the MODE key is set to save). The logic is similar with the previous one. You call the persisters for the current resource revision with an empty storage and then the ZipPackagePersister.

The FileLocator open method should have similar logic just in reverse. First it should call the ZipPackagePersister with an empty storage and then should pass this storage to the revision persister.

The revision persister`s logic should be separate for saving and loading. It should get the value of the PersistenceKey HISTORY_LEN and call the changes persister for the last x changes. It calls the ResourceModelPersister for the initial model. The order of those depends on the Mode.

We will no longer need separate persisters for books, pages, frames, annotation sets, etc. Every Key will have a method persist(). It will be used by the ResourceModelPersister for persistence of the value kept by this key in the model. The method will take arguments:

• the persisted format.
  
  
• ValueRef to the persisted value
  
  
• Storage where the value should be persisted
  
  
• and persistence options.
  
  

The default behavior of this method should be to check if it is loading value that was not persisted. In this case it should just set the ref to null. Otherwise should be called the appropriate persister for the child of the given storage with name- the last part of the key`s id. The best way to find the appropriate persistence schema is using a utility method from the PersistenceUtil.

This logic should be provided by the persistR3() method of the DefaultPersistableKey that inherits Key. The Simple and Templated Keys should inherit the DefaultPersistableKey. Some of the concrete keys in the model should override this method.

The RootKey and CompositeKey should inherit the abstract class SubEntriesKey that extends Key<SubEntryNames> and implements the get method as simply calls the getRaw() from the model. Its persistR3 method should never be called and thus should throw an unhandled exception. It should also provide method getSubEntryNames() that takes a class argument and returns the all possible sub-entries of the key. This method will be used by the ResourceModelPersister.

There will be no change in the persistence of the children elements. They are attributes in the same storage as the _resource.xml and the ZipPackagePersister creates directories with the same names.

For backward compatibility the KEY_KIND should implement the persistence logic in more specific way: First it should call the StringPersister for the attribute “kind” of the given storage. If the given options point it is a save mode this is all but if you are loading there should be a check if this is an old resource and its kind is just “frame”. In that case you should get the child “content” of the given storage and get its attribute kind. Then you should compose the string to be set to the value ref by the content type + “-frame”.

There are some other model keys that override the persistR3 method to implement specific logic or for backward compatibility.

ImmList

ChannelPersister

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.)}