Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

My Design Choices!

 
Vikas Sood
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
================================================= :MAIN CONTENTS:
=================================================
1]Overview.
2]Server Design.
3]Client Design.
4]Record Locking implementation.
5]Record Search implementation.
6]RMI vs Sockets based Remote Server implementation.
7]Modification vs Extension of Data class.
8]DefaultTableModel vs Extending AbstractTableModel.
9)Generic Client vs Generic Server.
10]Use of standard design patterns.
11]Exception handling scenarios.
12]Thread Safety.
13]Flexibilty for extension in future implementations.
14]Code clarity.
15]Class and its members naming convention and use of intuitive field names.
16]Documentation.
17]Final Packaging for submission.
Think thats enough,
Kindly Comment
VikasSood
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 11907
207
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Very comprehensive. You have more categories than I did, but I think I covered the same ground as you.
Just for your information, the categories I had were:
  • Overview
  • Class Diagrams
  • General Considerations
  • Client design
  • Server design
  • Deprecated Methods
  • Enhancement of the Data Class
  • Locking methodology
  • Deadlock Prevention
  • Network methodology
  • Major Design Patterns Used
  • Heirachial Model View Controller (HMVC)
  • Observer - Observable
  • Chain Of Responsibility
  • Singleton
  • Factory
  • Exception Handling
  • Record Searching
  • Handling of possible database modifications
  • Model used for displaying data in JTable
    Regards, Andrew
    [ June 20, 2003: Message edited by: Andrew Monkhouse ]
  •  
    Billy Tsai
    Ranch Hand
    Posts: 1304
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    how can I put diagrams into a txt file(I assume its created with notepad under Windows?)
    or do you guys just write description of the diagram but not really draw it in the txt file?
     
    Andrew Monkhouse
    author and jackaroo
    Marshal Commander
    Pie
    Posts: 11907
    207
    C++ Firefox Browser IntelliJ IDE Java Mac Oracle
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Hi Billy
    I did the old Fly By Night Services assignment, and in that we were allowed to submit the design decisions in any format we liked. So mine was in HTML, and my UML application allowed me to export all my class diagrams as JPG files, so I included them.
    I do recall one person here including text class diagrams. This is not very difficult:
    But I think most people dont bother with class diagrams.
    Regards, Andrew
     
    Billy Tsai
    Ranch Hand
    Posts: 1304
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    can I use notepad in windows to write choices.txt and version.txt because I dont know how to put diagram in there with notepad?
    how many pages did you guys wrote?
    and how did you determine the number of pages u wrote
     
    Andrew Monkhouse
    author and jackaroo
    Marshal Commander
    Pie
    Posts: 11907
    207
    C++ Firefox Browser IntelliJ IDE Java Mac Oracle
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Hi Billy
    Yes, you can use notepad to write your documentation. All you need to ensure is that the files that Sun tells you must be in text format are in text format - Notepad will save your files in Microsoft text format, so you are safe.
    Don't get stressed about diagrams. You dont need them. If you do want to add them, then take a look at how I did the MVC diagram above - that is just plain text.
    I normally do not care about counting lines of code, or numbers of classes, or numbers of pages of documentation. To me: once the documentation is clear, it is complete. I don't care if it is twice as many pages as someone else, or half the pages of someone else. The exception of course, is when writing something that has a fixed word limit.
    However since you asked, I will try and count them
    [andrewm@andrewm scjd]$ wc -l README.txt
    414 README.txt
    [andrewm@andrewm scjd]$ echo $((414/66))
    6
    So, assuming 66 lines per page, we get 6 pages for my README.txt file.
    My DesignChoices.html file was in html format (we were allowed this in the old assignment). Loading that into my word processor shows 11 pages.
    My user documentation totalled 19 pages (roughly 2 pages for each major screen, plus additional pages for modules as a whole). Also in html format.
    By the way, I am constantly accused of writing too much (just look at how long any of my posts are )
    Regards, Andrew
     
    Eben Hewitt
    Author
    Ranch Hand
    Posts: 36
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    My choices.txt ended up at about 15 pages. I write too much too. I know people have passed with just a couple of pages.

    I organized my file differently, however. I chose, out of sheer paranoia, like much else I did in my assignment, to follow the instructions exactly. So where it says, in my Bodgitt and Scarper instructions

    "Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made when resolving them."...

    My headings became:
    problems perceived
    value judgments
    decisions made
    uncertainties
    resolutions to uncertainties

    Then i described locks, threads, etc as appropriate.

    I was just trying to make it easy for my thick self to figure out if I crossed all my Ts and like that.
     
    Andrew Monkhouse
    author and jackaroo
    Marshal Commander
    Pie
    Posts: 11907
    207
    C++ Firefox Browser IntelliJ IDE Java Mac Oracle
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Hi Eben,

    I organized my file differently, however. I chose, out of sheer paranoia, like much else I did in my assignment, to follow the instructions exactly. So where it says, in my Bodgitt and Scarper instructions


    Very wise decision.

    Vikas and I were both working on the Fly By Night Services assignment, which has different documentation requirements than the current (URLyBird and Bodgitt & Scarper) assignments.

    When in doubt, always follow your instructions.

    Regards, Andrew
     
    • Post Reply
    • Bookmark Topic Watch Topic
    • New Topic