OOP Analysis Design Mandatory Principles - Revision history

Wikicatglobe at 02:10, 18 October 2013

2013-10-18T02:10:48Z

← Older revision		Revision as of 02:10, 18 October 2013
Line 1:		Line 1:
	<accesscontrol>~~Administrators,,Cem,,Maysunshine~~</accesscontrol>		<accesscontrol>Main:MyGroup</accesscontrol>
	[[Category:Miscellaneous]]		[[Category:Miscellaneous]]

Cg_pham at 10:01, 24 October 2011

2011-10-24T10:01:27Z

← Older revision		Revision as of 10:01, 24 October 2011
Line 1:		Line 1:
	<accesscontrol>Administrators,,Cem,,Maysunshine</accesscontrol>		<accesscontrol>Administrators,,Cem,,Maysunshine</accesscontrol>
	[[Category:~~Guidelines~~]]		[[Category:Miscellaneous]]

	== Open & Closed Principle (OCP)<br> ==		== Open & Closed Principle (OCP)<br> ==

Cg_pham at 07:37, 5 October 2011

2011-10-05T07:37:09Z

← Older revision		Revision as of 07:37, 5 October 2011
Line 1:		Line 1:
			<accesscontrol>Administrators,,Cem,,Maysunshine</accesscontrol>
			[[Category:Guidelines]]

	== Open & Closed Principle (OCP)<br> ==		== Open & Closed Principle (OCP)<br> ==

Catglobe at 03:30, 5 July 2010

2010-07-05T03:30:35Z

← Older revision		Revision as of 03:30, 5 July 2010
Line 272:		Line 272:
	== Single Responsibility Principle (SRP)<br> ==		== Single Responsibility Principle (SRP)<br> ==

	==== Introduction<br> ====		=== Introduction<br> ===

	SRP is a principle used to assure that objects should be <u>'''simplest'''</u>and <u>'''most concrete'''</u> at much as possible.<br>		SRP is a principle used to assure that objects should be <u>'''simplest'''</u>and <u>'''most concrete'''</u> at much as possible.<br>

	That means that we try to implement an object with exact features it should own, avoid its non-instinctive function.<br>		That means that we try to implement an object with exact features it should own, avoid its non-instinctive function.<br>

	==== Description<br> ====		=== Description<br> ===

	The object should be splitted into objects handle exactly what operations they should take.<br>		The object should be splitted into objects handle exactly what operations they should take.<br>

	Further than DRY, the question becomes not only "Can we collect the physical duplication into one place ?", but as well "Can we reduce duplication by separating the business duplication out of its object"<br>		Further than DRY, the question becomes not only "Can we collect the physical duplication into one place ?", but as well "Can we reduce duplication by separating the business duplication out of its object"<br>

	==== Specification<br> ====		=== Specification<br> ===

	To apply above description, there are steps:<br>		To apply above description, there are steps:<br>

	#Where ? Spot multiple responsibilities<br>		#Where ? Spot multiple responsibilities<br>
	#Then How ? Look into the operations/properties and move it to right location/split it if possible. Then come back to step #1<br>		#Then How ? Look into the operations/properties and move it to right location/split it if possible. Then come back to step #1<br>

	==== Application<br> ====		=== Application<br> ===

	In new Report engine<br>		In new Report engine<br>

	==== Example<br> ====		=== Example<br> ===

	ExpressionResolver is a common class. TrackingDiagramInfo was using it directly, as properties called OriginalExpression and Expressions.<br>		ExpressionResolver is a common class. TrackingDiagramInfo was using it directly, as properties called OriginalExpression and Expressions.<br>

	<source lang="csharp">/// <summary>		<source lang="csharp">/// <summary>
Line 311:		Line 311:
	/// </summary>		/// </summary>
	[Common.Serialization.NonSerialized]		[Common.Serialization.NonSerialized]
	public ExpressionResolver[][] Expressions { get; set; }</source><br>		public ExpressionResolver[][] Expressions { get; set; }</source><br>

	These were initialized by Javascript<br>		These were initialized by Javascript<br>

	<source lang="javascript">Type.registerNamespace("CatGlobe.Framework.Report.Diagrams.ExpressionResolver");		<source lang="javascript">Type.registerNamespace("CatGlobe.Framework.Report.Diagrams.ExpressionResolver");
Line 338:		Line 338:
	itms.push(new CatGlobe.Framework.Report.Diagrams.ExpressionResolver(childItemNode.getAttribute("name"), childItemNode.getAttribute("value")));		itms.push(new CatGlobe.Framework.Report.Diagrams.ExpressionResolver(childItemNode.getAttribute("name"), childItemNode.getAttribute("value")));
	}		}
	}</source><br>		}</source><br>

	and Json converter<br>		and Json converter<br>

	<source lang="csharp">/// <summary>		<source lang="csharp">/// <summary>
Line 373:		Line 373:
	}		}
	}		}
	}</source><br>		}</source><br>

	and also used for UnitTest<br>		and also used for UnitTest<br>

	Besides <span style="color: rgb(255, 0, 0);">'''Value '''</span>is already indicated as the most basic one of a brand expression, when <span style="color: rgb(0, 0, 255);">'''Base '''</span>began to be needed, it should be considered where to implement.<br>		Besides <span style="color: rgb(255, 0, 0);">'''Value '''</span>is already indicated as the most basic one of a brand expression, when <span style="color: rgb(0, 0, 255);">'''Base '''</span>began to be needed, it should be considered where to implement.<br>

	Firstly Base was considered to be put in ExpressionResolver. But in fact Base is not a exact instinctive property of ExpressionResolver. Just think about ExpressionResolver, not only applied for Tracking/Campaign, but also for Cross/Standard, then why Cross/Standard must have Base when they don't need that feature ? This could lead a further unncessary bulky mess, such as UnitTest for Cross/Standard.<br>		Firstly Base was considered to be put in ExpressionResolver. But in fact Base is not a exact instinctive property of ExpressionResolver. Just think about ExpressionResolver, not only applied for Tracking/Campaign, but also for Cross/Standard, then why Cross/Standard must have Base when they don't need that feature ? This could lead a further unncessary bulky mess, such as UnitTest for Cross/Standard.<br>

	Then we decided to create a new class called TrackingDiagramExpressionResolver - inheriting from ExpressionResolver - having ability to handle the specific features of Tracking (later should be CampaignDiagramExpressionResolver) like Base (and more ... ?).<br>		Then we decided to create a new class called TrackingDiagramExpressionResolver - inheriting from ExpressionResolver - having ability to handle the specific features of Tracking (later should be CampaignDiagramExpressionResolver) like Base (and more ... ?).<br>

	<source lang="csharp">/// <summary>		<source lang="csharp">/// <summary>
Line 447:		Line 447:

	#endregion		#endregion
	}</source><br>		}</source><br>

	Then TrackingDiagramInfo's OriginalExpression and Expressions initialization by Javascript becomes<br>		Then TrackingDiagramInfo's OriginalExpression and Expressions initialization by Javascript becomes<br>

	<source lang="javascript">Type.registerNamespace("CatGlobe.Framework.Report.Diagrams.TrackingDiagramExpressionResolver");		<source lang="javascript">Type.registerNamespace("CatGlobe.Framework.Report.Diagrams.TrackingDiagramExpressionResolver");
Line 478:		Line 478:
	itms.push(new CatGlobe.Framework.Report.Diagrams.TrackingDiagramExpressionResolver(childItemNode.getAttribute("name"), childItemNode.getAttribute("value"), childItemNode.getAttribute("base"), index));		itms.push(new CatGlobe.Framework.Report.Diagrams.TrackingDiagramExpressionResolver(childItemNode.getAttribute("name"), childItemNode.getAttribute("value"), childItemNode.getAttribute("base"), index));
	}		}
	}</source>		}</source>

	and Json converter becomes		and Json converter becomes

	<source lang="csharp">/// <summary>		<source lang="csharp">/// <summary>
Line 517:		Line 517:
	}		}
	}		}
	}</source>		}</source>

	and UnitTest changed also		and UnitTest changed also

	== Liskov Substitution Principle (LSP)<br> ==		== Liskov Substitution Principle (LSP)<br> ==

Catglobe at 03:30, 5 July 2010

2010-07-05T03:30:06Z

Show changes

Catglobe at 03:27, 5 July 2010

2010-07-05T03:27:06Z

Show changes

Catglobe at 02:41, 29 April 2010

2010-04-29T02:41:24Z

← Older revision		Revision as of 02:41, 29 April 2010
Line 263:		Line 263:
	}</source>		}</source>

	==== Note<br> ====		==== Note<br> ====

	SetPredefinedCriteriaExtension and SetPredefinedLayoutExtension seems the same to each other because DRY here can't be applied anymore as the limitation of an extension class<br>		*SetPredefinedCriteriaExtension and SetPredefinedLayoutExtension seems the same to each other because DRY here can't be applied anymore as the limitation of an extension class<br>
			*When hidden filters are determined to be applied in TrackingDiagramInfo, it's easy to see that hidden filter applying process of Cross, in fact, is the very general one. So we may move CrossDiagramInfo applying hidden filter code up to DiagramInfo, then remove the one in CrossDiagramInfo & unnecessary to add this into TrackingDiagramInfo. That's another DRY.

	=== Example 2<br> ===		=== Example 2<br> ===

Catglobe at 03:18, 27 April 2010

2010-04-27T03:18:35Z

← Older revision		Revision as of 03:18, 27 April 2010
Line 262:		Line 262:
	}		}
	}</source>		}</source>

			==== Note<br> ====

			SetPredefinedCriteriaExtension and SetPredefinedLayoutExtension seems the same to each other because DRY here can't be applied anymore as the limitation of an extension class<br>

	=== Example 2<br> ===		=== Example 2<br> ===
Line 267:		Line 271:
	One more example. In this situation it's harder to see any really "repeating" code. But let's stare into the whole structure of classes, those were really ones, with the same bussiness repeating (it might become more and more if expanded later)<br>		One more example. In this situation it's harder to see any really "repeating" code. But let's stare into the whole structure of classes, those were really ones, with the same bussiness repeating (it might become more and more if expanded later)<br>

	Original design		==== Original design ====

	<br>		<br>

	'''''The mapping process - here is text mapping - was spreading due to the functionalities (representing by properties Func...).'''''		'''''The mapping process - here is text mapping - was spreading due to the functionalities (representing by properties Func...).'''''

			==== Improved design<br> ====

	So, the design should have become		So, the design should have become
Line 437:		Line 443:
	}</source>		}</source>

	'''''As the result, any mapping process - here is text mapping - only takes place in only one place : Overriding MappingFunc of FreeLabelTextMapper'''''		'''''As the result, any mapping process - here is text mapping - only takes place in only one place : Overriding MappingFunc of FreeLabelTextMapper'''''

	~~=== Note<br> ===~~

	~~SetPredefinedCriteriaExtension and SetPredefinedLayoutExtension seems the same to each other because DRY here can't be applied anymore as the limitation of an extension class<br>~~

	<br>		<br>

Catglobe at 03:14, 27 April 2010

2010-04-27T03:14:53Z

← Older revision		Revision as of 03:14, 27 April 2010
Line 270:		Line 270:

	<br>		<br>

			'''''The mapping process - here is text mapping - was spreading due to the functionalities (representing by properties Func...).'''''

	So, the design should have become		So, the design should have become
Line 435:		Line 437:
	}</source>		}</source>

	As the result, any mapping process (here is text mapping) only takes place in only one place : Overriding MappingFunc of FreeLabelTextMapper		'''''As the result, any mapping process - here is text mapping - only takes place in only one place : Overriding MappingFunc of FreeLabelTextMapper'''''

	=== Note<br> ===		=== Note<br> ===

Catglobe at 03:03, 27 April 2010

2010-04-27T03:03:48Z

← Older revision		Revision as of 03:03, 27 April 2010
Line 263:		Line 263:
	}</source>		}</source>

	=== Example 2<br> ===		=== Example 2<br> ===

	One more example. In this situation it's harder to see any really "repeating" code. But let's stare into the whole structure of classes, those were really ones, with the same bussiness repeating (it might become more and more if expanded later)<br>		One more example. In this situation it's harder to see any really "repeating" code. But let's stare into the whole structure of classes, those were really ones, with the same bussiness repeating (it might become more and more if expanded later)<br>

	Original design		Original design

			<br>

			So, the design should have become

	~~So, the design should have become~~		<br>

			==== FreeLabelMapper & FreeLabelTextMapper ====

	==== FreeLabelMapper & FreeLabelTextMapper ====

	<source lang="csharp">public class FreeLabelTextMapper : FreeLabelMapper		<source lang="csharp">public class FreeLabelTextMapper : FreeLabelMapper
Line 320:		Line 320:

	#endregion		#endregion
	}</source>		}</source>

	==== FreeLabelHandler ====		==== FreeLabelHandler ====

	<source lang="csharp">public IList<FreeLabelTextMapper> TextMappers { get; protected set; }</source>		<source lang="csharp">public IList<FreeLabelTextMapper> TextMappers { get; protected set; }</source>

	<source lang="csharp">internal FreeLabelHandler()		<source lang="csharp">internal FreeLabelHandler()
Line 346:		Line 346:
	});		});
	Validate();		Validate();
	}</source>		}</source>

	<source lang="csharp">/// <summary>		<source lang="csharp">/// <summary>
Line 365:		Line 365:
	}		}
	FreeLabels = freeLabels;		FreeLabels = freeLabels;
	}</source>		}</source>

	==== TrackingDiagramFreeLabelHandler ====		==== TrackingDiagramFreeLabelHandler ====

	<source lang="csharp">internal TrackingDiagramFreeLabelHandler(DiagramInfo trackingDiagramInfo, Diagram diagram)		<source lang="csharp">internal TrackingDiagramFreeLabelHandler(DiagramInfo trackingDiagramInfo, Diagram diagram)
Line 433:		Line 433:
	((TrackingDiagramInfo) DiagramInfo).TimePeriod.RollingAverage, WeekText) }		((TrackingDiagramInfo) DiagramInfo).TimePeriod.RollingAverage, WeekText) }
	});		});
	}</source>		}</source>

			As the result, any mapping process (here is text mapping) only takes place in only one place : Overriding MappingFunc of FreeLabelTextMapper

	=== Note<br> ===		=== Note<br> ===