• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Tim Cooke
  • paul wheaton
  • Jeanne Boyarsky
  • Ron McLeod
Sheriffs:
  • Paul Clapham
  • Liutauras Vilda
  • Devaka Cooray
Saloon Keepers:
  • Tim Holloway
  • Roland Mueller
Bartenders:

Part 2 assignment level of detail

 
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hello Ranchers,

I've read a lot of threads trying to figure out the level of detail I should include in my assignment, but there seems to be no clear consensus. So, as I'm about to submit my assignment I would like to ask if what I did is enough to avoid problems with Oracle. Below is description of what is included in the diagrams.

Class diagrams
To avoid a diagram that is too big I used 2 class diagrams, one has the JSPs and JSF backing beans and also show the EJBs used by the backing beans. This diagram has 11 JSPs and 9 classes. The other diagram contains the business classes, including the JPA entities and session beans. This diagram has 34 classes, of these 17 domain model classes, 2 are session beans and the rest are DAOs, interfaces, etc.
Also, I did not shown all dependencies between all classes using UML dependency association (dashed line) and the <<use>> stereotype, this would make the diagram unreadable. I added I note about this.

Component diagram
Here I followed the example from Cade's book. I did not show individual DAOs, entities, etc. I grouped JSPs in 3 differente components (each one has it's purpose); showed the 2 session beans with their interfaces; the JPA entities and DAOs are represented by a single component; showed the components that make integration to external systems; showed the external systems marked with <<external>> stereotype. I have 15 components in this diagram, they are presented separated by tier.

Here I did something that I have seen in Cade's book component diagram example. I added a component named "Servlet filters and listeners" to show that these are needed but in my class diagrams nothing is shown about this component. I added text to the diagram to explain this case and included this component to show that this was considered during the architecture design.

Deployment diagram
This is pretty much like the example in Cade's book.

Sequence diagrams
The sequence diagrams are mode detailed than Cade's book, showing method parameters and return values.


What do you think? Should I change anything? I would like to hear particularly about the class and component diagrams.

Thanks in advance.
 
author & internet detective
Posts: 42103
933
Eclipse IDE VI Editor Java
  • Likes 1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Tobias,
Welcome to CodeRanch!

I think your level of detail is perfect. You show everything in the class diagram and use the component diagram for a summary.

I also like how you summarized your submission without saying anything inappropriate or giving anything away.
 
Ranch Hand
Posts: 100
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
In the component diagram, don't you put the boxes for the backing beans in the web layer?
 
Ranch Hand
Posts: 133
Eclipse IDE Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Nilessh Ganu wrote:In the component diagram, don't you put the boxes for the backing beans in the web layer?



I did so.
 
Ranch Hand
Posts: 65
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Dear All,

The only thing that is holding me from submitting my assignment is ... the Component diagram ! I don't feel that mine is worth 40 points or maybe it is, but I'm just affraid Am I the only one who is feeling like this ?

After going throw many posts, I came up with some questions about the Component diagram :

1) Some people are saying they have put the related JSPs in one box, and their Backing Beans in another. Some did not mention the Backing Beans at all. Who's right ?

2) Some people have put the SLSB in one box, and the implementation in another. Some only mentioned the SLSB without showing the implementation box. Who's right ?

3) When naming the components, should they be the same name as in Class diagram or different ? ex: in Class diagram : AssignmentDAO, in Component diagram: Assignment DAO (with a space between the two words)

4) Some people are showing Framework classes, ex: EntityManager, FacesServlet, ... Some are not. Who's right ?

I'm sorry if some of these questions are redundant, but in every post you find the same famous "Its up to you" sentence

Thank you a lot ALL !
 
Tobias Spinlock
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Nilessh Ganu wrote:In the component diagram, don't you put the boxes for the backing beans in the web layer?



Yes, I did.
 
Krzysztof Koziol
Ranch Hand
Posts: 133
Eclipse IDE Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
As per Cade & Sheil, what about classes that are listed in brackets in each component in the business tier? I agree that *Manager classes should be listed there but what about Order, Bid etc.? First one is not in the Class Diagram but the second one is. What's the pattern?
 
Tobias Spinlock
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Luay Abdulraheem wrote:Dear All,

The only thing that is holding me from submitting my assignment is ... the Component diagram ! I don't feel that mine is worth 40 points or maybe it is, but I'm just affraid Am I the only one who is feeling like this ?

After going throw many posts, I came up with some questions about the Component diagram :

1) Some people are saying they have put the related JSPs in one box, and their Backing Beans in another. Some did not mention the Backing Beans at all. Who's right ?

2) Some people have put the SLSB in one box, and the implementation in another. Some only mentioned the SLSB without showing the implementation box. Who's right ?

3) When naming the components, should they be the same name as in Class diagram or different ? ex: in Class diagram : AssignmentDAO, in Component diagram: Assignment DAO (with a space between the two words)

4) Some people are showing Framework classes, ex: EntityManager, FacesServlet, ... Some are not. Who's right ?

I'm sorry if some of these questions are redundant, but in every post you find the same famous "Its up to you" sentence

Thank you a lot ALL !




1) I did separate them. I have boxes for JSPs and a single box for all backing beans.

2) I put a box for each session bean (I have only 2) and each box has the interface (lollipop) it provides.

3) I did this only for the session beans. As the other components are a summary the name is different. But each of my diagrams has an element calalog, a table that briefly describes each UML element in the diagram. In the element catalog I say what is in each component.

4) I did show only the faces servlet.
 
Luay Abdulraheem
Ranch Hand
Posts: 65
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks for your reply

Did you pass (are these answers from previous experience), or are you still doing the assignment and not sure that if these are the best practices ?
 
Tobias Spinlock
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Luay Abdulraheem wrote:Thanks for your reply

Did you pass (are these answers from previous experience), or are you still doing the assignment and not sure that if these are the best practices ?



I have not submitted the assignment yet and I was not sure about the level of detail. I wanted to hear from those who passed and who are still working on their assignments.
 
Their achilles heel is the noogie! Give them noogies tiny ad!
Smokeless wood heat with a rocket mass heater
https://woodheat.net
reply
    Bookmark Topic Watch Topic
  • New Topic