FreeMind refactoring plan - Revision history

Dan Polansky: +cat

2009-09-24T19:03:57Z

+cat

← Older revision		Revision as of 19:03, 24 September 2009
Line 60:		Line 60:
	\| All .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.		\| All .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.
	\|}		\|}

			[[Category:Development]]

Danielpolansky: Restore the proposal, so that anyone can see what it consists of

2009-01-14T08:13:36Z

Restore the proposal, so that anyone can see what it consists of

← Older revision		Revision as of 08:13, 14 January 2009
Line 1:		Line 1:
	~~[[User:DimitriPolivaev\|DimitriPolivaev]]<br>~~I propose following refactoring steps in order to improve ~~freemind~~'s architecture and design: see [http://freeplane.wiki.sourceforge.net/refactoring freeplane refactoring page].		I propose following refactoring steps in order to improve FreeMind's architecture and design: see [http://freeplane.wiki.sourceforge.net/refactoring freeplane refactoring page]. --[[User:DimitriPolivaev\|DimitriPolivaev]]

			{\| {{Table style}}
			\|+ Original proposal of refactoring
			! Keywords
			! Problem
			! Measure
			\|-
			\| Property packages
			\| Over sized Model and controller classes, different features are implemented in these kernel classes instead of their own separate and lose coupled classes.
			\| Split model and controller in multiple classes responsible for different node and map properties (node text, edges, clouds, icons etc). Put thess classes in different packages. Provide facade classes for the packages. The classes containing the actions should be specified in mindmap_menus.xml.

			Different packages should be introduced for:
			* node formatting
			* text formatting
			* clouds
			* edges
			* icons
			* attributes
			and so on.

			\|-
			\| Menu builder
			\| Lack of menu building component. The job is done by different controller classes which makes the menu difficult to extend.
			\| Introducing of menu builder (Design Pattern “Builder”) which can be accessed from all interested components during their initialization.

			\|-
			\| Undo handling
			\| Using jibx for XML serialisation of actions requires extending of the one xml document “freemind.xsd” for generation of marshallers and unmarshallers. Plug-ins can not add their own properties to maps and nodes without extending this file if they want to define their own actions.

			Separation of action beans generated from this file from action code makes the code difficult to maintain and to understand.
			\| Use of [http://xstream.codehaus.org/ XStream library] instead of jibx for XML – Serialisation.


			Move action data into actor classes and let XStream do the rest.

			\|-
			\| Application classes
			\| Application initialization and building of application frame including tabbed panewith the map tabs, , scroll pane, split pane and so one is implemented in one class FreeMind which also extends JFrame.
			\| Move application initialization logic and tab management into new classes.

			\|-
			\| OSGI
			\| Very complex extension mechanism (Hooks) with long class inheritance hierarchies.
			\| Use extension objects pattern for model and controller. When model and controller should not depend on the property packages. Replace current Hooks by OSGI plug-ins directly extending controller and model classes via Extension Object pattern.

			\|-
			\| Preferences pane builder
			\| Almost elements of preference dialog set up in a single place.
			\| Introducing of property editor builder (Design Pattern “Builder”). The same bilder can also be used for building formatting dialogs.

			\|-
			\| Map loading and saving.
			\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand. Loading and saving of map and node properties should be implemented in property packages, not at the central place.
			\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created.

			\|-
			\| Models overloaded by loading and saving code.
			\| Saving and Loading code belongs to model classes instead of controller classes. This leads to different model classes for browse and mind map editing modes.
			\| All .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.
			\|}

DimitriPolivaev at 19:31, 7 July 2008

2008-07-07T19:31:57Z

← Older revision		Revision as of 19:31, 7 July 2008
Line 1:		Line 1:
	[[User:DimitriPolivaev\|DimitriPolivaev]]<br>I propose following refactoring steps in order to improve freemind's architecture and design:		[[User:DimitriPolivaev\|DimitriPolivaev]]<br>I propose following refactoring steps in order to improve freemind's architecture and design: see [http://freeplane.wiki.sourceforge.net/refactoring freeplane refactoring page].

	~~{\| class="prettytable" border="1"~~
	~~\| Keywords~~
	~~\| Problem~~
	~~\| Measure~~

	\|-
	~~\| Property packages~~
	~~\| Over sized Model and controller classes, different features are implemented in these kernel classes instead of their own separate and lose coupled classes.~~
	\| Split model and controller in multiple classes responsible for different node and map properties (node text, edges, clouds, icons etc). Put thess classes in different packages. Provide facade classes for the packages. The classes containing the actions should be specified in mindmap_menus.xml.

	~~Different packages should be introduced for:~~
	* node formatting
	* text formatting
	* clouds
	* edges
	* icons
	* attributes
	~~and so on.~~

	\|-
	~~\| Menu builder~~
	~~\| Lack of menu building component. The job is done by different controller classes which makes the menu difficult to extend.~~
	~~\| Introducing of menu builder (Design Pattern “Builder”) which can be accessed from all interested components during their initialization.~~

	\|-
	~~\| Undo handling~~
	\| Using jibx for XML serialisation of actions requires extending of the one xml document “freemind.xsd” for generation of marshallers and unmarshallers. Plug-ins can not add their own properties to maps and nodes without extending this file if they want to define their own actions.

	~~Separation of action beans generated from this file from action code makes the code difficult to maintain and to understand.~~
	~~\| Use of~~ [http://~~xstream~~.~~codehaus~~.~~org~~/ ~~XStream library~~] ~~instead of jibx for XML – Serialisation.~~


	~~Move action data into actor classes and let XStream do the rest.~~

	\|-
	~~\| Application classes~~
	\| Application initialization and building of application frame including tabbed panewith the map tabs, , scroll pane, split pane and so one is implemented in one class FreeMind which also extends JFrame.
	~~\| Move application initialization logic and tab management into new classes.~~

	\|-
	~~\| OSGI~~
	~~\| Very complex extension mechanism (Hooks) with long class inheritance hierarchies.~~
	\| Use extension objects pattern for model and controller. When model and controller should not depend on the property packages. Replace current Hooks by OSGI plug-ins directly extending controller and model classes via Extension Object pattern.

	\|-
	~~\| Preferences pane builder~~
	~~\| Almost elements of preference dialog set up in a single place.~~
	~~\| Introducing of property editor builder (Design Pattern “Builder”). The same bilder can also be used for building formatting dialogs.~~

	\|-
	~~\| Map loading and saving.~~
	\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand. Loading and saving of map and node properties should be implemented in property packages, not at the central place.
	~~\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created.~~

	\|-
	~~\| Models overloaded by loading and saving code.~~
	~~\| Saving and Loading code belongs to model classes instead of controller classes. This leads to different model classes for browse and mind map editing modes.~~
	\| All .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.
	\|}

DimitriPolivaev at 07:12, 4 June 2008

2008-06-04T07:12:52Z

← Older revision		Revision as of 07:12, 4 June 2008
Line 51:		Line 51:

	\|-		\|-
	\| Map loading.		\| Map loading and saving.
	\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand. Loading and saving of map and node properties should be implemented in property packages, not at the central place.		\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand. Loading and saving of map and node properties should be implemented in property packages, not at the central place.
	\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created.		\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created.

DimitriPolivaev at 07:12, 4 June 2008

2008-06-04T07:12:17Z

← Older revision		Revision as of 07:12, 4 June 2008
Line 17:		Line 17:
	* edges		* edges
	* icons		* icons
	\|-		* attributes
	~~\| Map loading and saving.~~
	~~\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.~~
	\| * attributes
	and so on.		and so on.

DimitriPolivaev: loading and saving

2008-05-01T12:12:13Z

loading and saving

← Older revision		Revision as of 12:12, 1 May 2008
Line 17:		Line 17:
	* edges		* edges
	* icons		* icons
	* attributes		\|-
			\| Map loading and saving.
			\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.
			\| * attributes
	and so on.		and so on.

Line 52:		Line 55:
	\|-		\|-
	\| Map loading.		\| Map loading.
	\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.		\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand. Loading and saving of map and node properties should be implemented in property packages, not at the central place.
	\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created~~. Loading and saving of properties should be implemented in property packages, not at the central place~~.		\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created.

	~~Both~~ .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.		\|-
			\| Models overloaded by loading and saving code.
			\| Saving and Loading code belongs to model classes instead of controller classes. This leads to different model classes for browse and mind map editing modes.
			\| All .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.
	\|}		\|}

DimitriPolivaev at 12:05, 1 May 2008

2008-05-01T12:05:32Z

← Older revision		Revision as of 12:05, 1 May 2008
Line 55:		Line 55:
	\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created. Loading and saving of properties should be implemented in property packages, not at the central place.		\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created. Loading and saving of properties should be implemented in property packages, not at the central place.

	Both .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there only differences between controllers.		Both .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there are only differences between controllers.
	\|}		\|}

DimitriPolivaev at 12:05, 1 May 2008

2008-05-01T12:05:05Z

← Older revision		Revision as of 12:05, 1 May 2008
Line 53:		Line 53:
	\| Map loading.		\| Map loading.
	\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.		\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.
	\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created. Loading and saving of properties should be implemented in property packages, not at the central place. Both .load and .save methods should be moved from model to controller classes.		\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created. Loading and saving of properties should be implemented in property packages, not at the central place.

			Both .load and .save methods should be moved from model to controller classes. So the model classes of browse mode and of mind map editing mode become identical, there only differences between controllers.
	\|}		\|}

DimitriPolivaev at 10:12, 20 April 2008

2008-04-20T10:12:48Z

← Older revision		Revision as of 10:12, 20 April 2008
Line 17:		Line 17:
	* edges		* edges
	* icons		* icons
	* attributes and so on.		* attributes
			and so on.

	\|-		\|-

DimitriPolivaev at 10:11, 20 April 2008

2008-04-20T10:11:28Z

← Older revision		Revision as of 10:11, 20 April 2008
Line 8:		Line 8:
	\|-		\|-
	\| Property packages		\| Property packages
	\| Over sized Model and controller classes, different features are implemented in these kernel classes instead of their own separate and ~~losse~~ coupled classes.		\| Over sized Model and controller classes, different features are implemented in these kernel classes instead of their own separate and lose coupled classes.
	\| Split model and controller in multiple classes responsible for different node and map properties (node text, edges, clouds, icons etc). Put thess classes in different packages. Provide facade classes for the packages. The classes containing the actions should be specified in mindmap_menus.xml.		\| Split model and controller in multiple classes responsible for different node and map properties (node text, edges, clouds, icons etc). Put thess classes in different packages. Provide facade classes for the packages. The classes containing the actions should be specified in mindmap_menus.xml.

			Different packages should be introduced for:
			* node formatting
			* text formatting
			* clouds
			* edges
			* icons
			* attributes and so on.

	\|-		\|-
Line 44:		Line 52:
	\| Map loading.		\| Map loading.
	\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.		\| FreeMind specific code introduced directly into XML parser XMLElement. Mixing of XML parsing logic with freemind logic makes code difficult to understand.
	\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created. Both .load and .save methods should be moved from model to controller classes.		\| New class NodeXmlElement extending XMLElement should contain freemind specific issues. .load(XMLElement e) methods symmetric to existing .save(XMLElement) methods should be created. Loading and saving of properties should be implemented in property packages, not at the central place. Both .load and .save methods should be moved from model to controller classes.
	\|}		\|}