CSC/ECE 517 Spring 2013/OSS M604 - Revision history

Ragarwa2: /* Object-Oriented Design Principles */

2013-04-05T22:20:41Z

Object-Oriented Design Principles

← Older revision		Revision as of 22:20, 5 April 2013
Line 66:		Line 66:
	<b>Open-Closed Principle</b>		<b>Open-Closed Principle</b>
	<br>		<br>
	In the OpenMRS module, existing classes that had already been tested were not modified, which exemplifies the open-closed principle [http://en.wikipedia.org/wiki/Open/closed_principle]. This module is an extension of the OpenMRS functionality. Our ChangeRelationshipsServiceImpl class is an added class to specifically add the functionality of being able to update the relationships of several patients at one time. Specifically, in our the ChangeRelationshipServiceImpl, we extend the class BaseOpenmrsService to implement the new functionality:		In the OpenMRS module, existing classes that had already been tested were not modified, which exemplifies the open-closed principle [http://en.wikipedia.org/wiki/Open/closed_principle]. This module is an extension of the OpenMRS functionality. Our ChangeRelationshipsServiceImpl class is an added class to specifically add the functionality of being able to update the relationships of several patients at one time. Specifically, in our the ChangeRelationshipServiceImpl, we extend the class BaseOpenmrsService to implement the new functionality and we are able to utilize methods from BaseOpenmrsService through inheritance[http://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)]:
	public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService		public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService
	<br>		<br>

Ragarwa2: /* Object-Oriented Design Principles */

2013-04-05T22:18:07Z

Object-Oriented Design Principles

← Older revision		Revision as of 22:18, 5 April 2013
Line 43:		Line 43:
	<b>Encapsulation</b>		<b>Encapsulation</b>
	<br>		<br>
	There were several instances of encapsulation used through out our implementation code in the OpenMRS module. For example, to get access to relationships between people in the database in OpenMRS, we first had to use the Context class to get a PersonService object type and then use that object type to access a list of relationships:		There were several instances of encapsulation [http://en.wikipedia.org/wiki/Encapsulation_(object-oriented_programming)] used through out our implementation code in the OpenMRS module. For example, to get access to relationships between people in the database in OpenMRS, we first had to use the Context class to get a PersonService object type and then use that object type to access a list of relationships:
	personService = Context.getPersonService();		personService = Context.getPersonService();
	Here, getPersonService() is a static method in class Context that doesn't require instantiating a Context object to call the method. getPersonService() can be directly used as a class method without having to know the details of how the method has been implemented and designed.		Here, getPersonService() is a static method in class Context that doesn't require instantiating a Context object to call the method. getPersonService() can be directly used as a class method without having to know the details of how the method has been implemented and designed.
Line 70:		Line 70:
	<br>		<br>
	<b>Principle of Least Astonishment</b><br>		<b>Principle of Least Astonishment</b><br>
	The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors. The Change Relationship page allows a user to enter the person and relationship to update and then allows the user to enter the person and relationship to be updated to. <br>		The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors, which adheres to the Principle of Least Astonishment [http://en.wikipedia.org/wiki/Principle_of_least_astonishment]. The Change Relationship page allows a user to enter the person and relationship to update and then allows the user to enter the person and relationship to be updated to. <br>
	The same goes for the naming conventions of the functions in our ChangeRelationshipServiceImpl class, they are named so that it is easier for a person viewing the code to understand what the function does without really having to study the code:		The same goes for the naming conventions of the functions in our ChangeRelationshipServiceImpl class, they are named so that it is easier for a person viewing the code to understand what the function does without really having to study the code:
	public Person getPersonObjectFromInputname(String fromPerson);		public Person getPersonObjectFromInputname(String fromPerson);

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-29T04:23:34Z

Object-Oriented Design Principles

← Older revision		Revision as of 04:23, 29 March 2013
Line 72:		Line 72:
	The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors. The Change Relationship page allows a user to enter the person and relationship to update and then allows the user to enter the person and relationship to be updated to. <br>		The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors. The Change Relationship page allows a user to enter the person and relationship to update and then allows the user to enter the person and relationship to be updated to. <br>
	The same goes for the naming conventions of the functions in our ChangeRelationshipServiceImpl class, they are named so that it is easier for a person viewing the code to understand what the function does without really having to study the code:		The same goes for the naming conventions of the functions in our ChangeRelationshipServiceImpl class, they are named so that it is easier for a person viewing the code to understand what the function does without really having to study the code:
	public Person getPersonObjectFromInputname(String fromPerson);		public Person getPersonObjectFromInputname(String fromPerson);
			public RelationshipType findRelationshipTypeFromInput(String relation);
	public RelationshipType findRelationshipTypeFromInput(String relation);		int numberOfRelationships(Person fromPerson,RelationshipType fromPersonOldRelationshipTypeObject);
			int numberOfRelationships(Person fromPerson);
	int numberOfRelationships(Person fromPerson,RelationshipType fromPersonOldRelationshipTypeObject);		public boolean updateRelativesToNewPerson(Person p, RelationshipType rst);
			public List<Relationship> getAllRelatedPeople();
	int numberOfRelationships(Person fromPerson);

	public boolean updateRelativesToNewPerson(Person p, RelationshipType rst);

	public List<Relationship> getAllRelatedPeople();

	==Design Patterns==		==Design Patterns==

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-29T04:18:00Z

Object-Oriented Design Principles

@@ Line 70: / Line 70: @@
 <br>
 <b>Principle of Least Astonishment</b><br>
-The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors.
+The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors. The Change Relationship page allows a user to enter the person and relationship to update and then allows the user to enter the person and relationship to be updated to. <br>
 ==Design Patterns==

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-29T04:06:07Z

Object-Oriented Design Principles

← Older revision		Revision as of 04:06, 29 March 2013
Line 69:		Line 69:
	public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService		public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService
	<br>		<br>
	<b>~~Inheritance~~</b><br>		<b>Principle of Least Astonishment</b><br>
			The user interface for our module was designed to be simple and intuitive for the user and encompass the basic functionality of updating relationships of patients to doctors.

	==Design Patterns==		==Design Patterns==

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-29T03:42:53Z

Object-Oriented Design Principles

← Older revision		Revision as of 03:42, 29 March 2013
Line 69:		Line 69:
	public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService		public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService
	<br>		<br>
	<b>Inheritance</b>		<b>Inheritance</b><br>

	==Design Patterns==		==Design Patterns==

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-28T13:08:10Z

Object-Oriented Design Principles

← Older revision		Revision as of 13:08, 28 March 2013
Line 68:		Line 68:
	In the OpenMRS module, existing classes that had already been tested were not modified, which exemplifies the open-closed principle [http://en.wikipedia.org/wiki/Open/closed_principle]. This module is an extension of the OpenMRS functionality. Our ChangeRelationshipsServiceImpl class is an added class to specifically add the functionality of being able to update the relationships of several patients at one time. Specifically, in our the ChangeRelationshipServiceImpl, we extend the class BaseOpenmrsService to implement the new functionality:		In the OpenMRS module, existing classes that had already been tested were not modified, which exemplifies the open-closed principle [http://en.wikipedia.org/wiki/Open/closed_principle]. This module is an extension of the OpenMRS functionality. Our ChangeRelationshipsServiceImpl class is an added class to specifically add the functionality of being able to update the relationships of several patients at one time. Specifically, in our the ChangeRelationshipServiceImpl, we extend the class BaseOpenmrsService to implement the new functionality:
	public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService		public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService
			<br>
			<b>Inheritance</b>

	==Design Patterns==		==Design Patterns==

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-28T13:07:22Z

Object-Oriented Design Principles

← Older revision		Revision as of 13:07, 28 March 2013
Line 52:		Line 52:
	for(Relationship r : allRelatedPeople)		for(Relationship r : allRelatedPeople)
	{		{
	myLogger.print(r.getPersonB().getFamilyName() + " relationshiptype "		myLogger.print(r.getPersonB().getFamilyName() + " relationshiptype " + r.getRelationshipType().getaIsToB() + "/" + r.getRelationshipType().getbIsToA());
	+ r.getRelationshipType().getaIsToB() + "/"
	+ r.getRelationshipType().getbIsToA());
	}		}
	}		}
	This is a helper method to the ~~changePatientRelationships() method that helps locate~~ the ~~Person object for updating~~ the ~~patient relationship~~. As it is not directly used in the manage.jsp page for the user-interface, it is made private to restrict access to it.		This is a helper method to print the relationships in the Relationship List allRelatedPeople to the log file. As it is not directly used in the manage.jsp page for the user-interface, it is made private to restrict access to it.

	private ChangeRelationshipsDAO dao;		private ChangeRelationshipsDAO dao;
	private List<Person> people;		private List<Person> people;

Ragarwa2: /* Object-Oriented Design Principles */

2013-03-28T03:46:43Z

Object-Oriented Design Principles

← Older revision		Revision as of 03:46, 28 March 2013
Line 48:		Line 48:
	<br>		<br>
	Another example is making helper methods and instance variables private.		Another example is making helper methods and instance variables private.
	private ~~Person getPersonOut~~(~~List<~~Relationship~~> relationshipList, String nameOut~~)		private void printAllRelatedPeopleDetails()
			{
			for(Relationship r : allRelatedPeople)
			{
			myLogger.print(r.getPersonB().getFamilyName() + " relationshiptype "
			+ r.getRelationshipType().getaIsToB() + "/"
			+ r.getRelationshipType().getbIsToA());
			}
			}
	This is a helper method to the changePatientRelationships() method that helps locate the Person object for updating the patient relationship. As it is not directly used in the manage.jsp page for the user-interface, it is made private to restrict access to it.		This is a helper method to the changePatientRelationships() method that helps locate the Person object for updating the patient relationship. As it is not directly used in the manage.jsp page for the user-interface, it is made private to restrict access to it.

Line 63:		Line 71:
	In the OpenMRS module, existing classes that had already been tested were not modified, which exemplifies the open-closed principle [http://en.wikipedia.org/wiki/Open/closed_principle]. This module is an extension of the OpenMRS functionality. Our ChangeRelationshipsServiceImpl class is an added class to specifically add the functionality of being able to update the relationships of several patients at one time. Specifically, in our the ChangeRelationshipServiceImpl, we extend the class BaseOpenmrsService to implement the new functionality:		In the OpenMRS module, existing classes that had already been tested were not modified, which exemplifies the open-closed principle [http://en.wikipedia.org/wiki/Open/closed_principle]. This module is an extension of the OpenMRS functionality. Our ChangeRelationshipsServiceImpl class is an added class to specifically add the functionality of being able to update the relationships of several patients at one time. Specifically, in our the ChangeRelationshipServiceImpl, we extend the class BaseOpenmrsService to implement the new functionality:
	public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService		public class ChangeRelationshipsServiceImpl extends BaseOpenmrsService implements ChangeRelationshipsService



	==Design Patterns==		==Design Patterns==

Ykolesn: /* Example Video */

2013-03-23T16:48:42Z

Example Video

← Older revision		Revision as of 16:48, 23 March 2013
Line 1:		Line 1:
	=OpenMRS Change Patient Relationships=		=OpenMRS Change Patient Relationships=
	==Example Video==		==Example Video==
	A user example video can be found here [http://www.youtube.com/watch?v=Tzgz80T_H0s&feature=youtu.be]		A user example video can be found here [http://www.youtube.com/watch?v=Tzgz80T_H0s&feature=youtu.be]. Be sure to select the 720p HD option and full-screen for optimal viewing.

	== README ==		== README ==