aspose file tools*
The moose likes OO, Patterns, UML and Refactoring and the fly likes What UML diagram to design a Framework Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Engineering » OO, Patterns, UML and Refactoring
Bookmark "What UML diagram to design a Framework" Watch "What UML diagram to design a Framework" New topic
Author

What UML diagram to design a Framework

Tadili Saad
Greenhorn

Joined: Sep 17, 2008
Posts: 20
Hi,

For a university project I was given the task to design and implement an XML-relationnal framework.

After an analysis phase I have found the components that I need. I have done the following drawing to show the interaction between them




I would like to draw a UML diagram to explain how the component that process the annotations works (ie left part of the schema). I wrote a few sentences about how the component works, but I'd like to explain it also with a UML diagram. But what type of UML diagram do I need to use.

This is what I wrote.

The annotation processor takes the user annotated schema as an entry. It then parses the schema et verify the validity of the mappings used by the user. The annotations processor then creates a relationnal schema in the rdbms and persist the mapping information that the mapping interface will use in another database.

thanks
Jimmy Clark
Ranch Hand

Joined: Apr 16, 2008
Posts: 2187
You could most likely use all of the UML diagrams to show different perspectives of the annotation processor component.
Mike Peters
Ranch Hand

Joined: Oct 10, 2009
Posts: 67

I think an object collaboration diagram is closest to what you currently have.


Mike Peters
Sandeep Awasthi
Ranch Hand

Joined: Oct 23, 2003
Posts: 597
Tadili ,

I think you have drawn Sequence/Collaboration diagram with your own notations which are not standard.


Sandeep
Eduardo Yañez Parareda
Ranch Hand

Joined: Oct 09, 2008
Posts: 92

As Jimmy Clark has told you, you'll need several UML diagrams, it depends on which perspective of your framework you want to show.



http://serfj.sourceforge.net - Simplest Ever REST Framework for Java
Sandeep Awasthi
Ranch Hand

Joined: Oct 23, 2003
Posts: 597
You will need 4 types of UML diagrams.

  • Use case diagrams.
  • Class Diagrams.
  • Sequence / Collaboration Diagram.
  • Component Diagrams.


  • In addition, if you feel need and you have some complex processing flow, you can draw Activity Diagrams as a 5th set of Diagrams
    Jimmy Clark
    Ranch Hand

    Joined: Apr 16, 2008
    Posts: 2187
    Keep in mind that a framework and an application are not the same thing.

    If your task is design a "framework" for building applications that move data from XML format to relational format, then in your mind you need to think about the differences between a framework and an application. A "framework" is a skeleton. It does not do anything on its own. It is used to help with application development. You need think about what developers needs to do to build an application that moves data in this fashion. AND, then think about what "you" can do to help "them."

    Your objective and focus should be on helping application developers, not building an entire data processing application.
    Tadili Saad
    Greenhorn

    Joined: Sep 17, 2008
    Posts: 20
    Hi, excuse me for the late answer as I had problems with my internet provider.

    I had to mind to draw class diagram and sequence digramme when I start to design the framework.

    For the analysis part and to gather the requirements I think about drawing uses cases first. But the problem si that it is a framework. Until now I used to design only management application with actors in the use case as cashier, student. But now the users of my framework are other applications. So who what is the name of the actor in the use case (is it the user of the application that uses the framework), is it the application that uses the framework(but can an application be an actor in a use case). I'm kind of stuck here

    Also would it be wise to add state digrams ?

    For example a state diagram for the XML Schéma, the XML Document, the XML query something like this



    Thanks
    Tadili Saad
    Greenhorn

    Joined: Sep 17, 2008
    Posts: 20
    Jimmy Clark wrote:Keep in mind that a framework and an application are not the same thing.

    If your task is design a "framework" for building applications that move data from XML format to relational format, then in your mind you need to think about the differences between a framework and an application. A "framework" is a skeleton. It does not do anything on its own. It is used to help with application development. You need think about what developers needs to do to build an application that moves data in this fashion. AND, then think about what "you" can do to help "them."

    Your objective and focus should be on helping application developers, not building an entire data processing application.


    It should be something like hibernate...



    done in a month of time
    Eduardo Yañez Parareda
    Ranch Hand

    Joined: Oct 09, 2008
    Posts: 92

    but can an application be an actor in a use case


    Of course, whichever that interacts with your system is able to be an actor. For example If you have a system that receives files from another one to create something... then the system that send files could be an actor.

    Also would it be wise to add state digrams ?


    As I said you, it depends on which perspectives you want to show. If you consider that is useful for users to show a state diagram, then make it!.
    Tadili Saad
    Greenhorn

    Joined: Sep 17, 2008
    Posts: 20
    OK, I need to read back some UML I'm kind of a bit rusted in that department.

    Thank you all
     
    I agree. Here's the link: http://aspose.com/file-tools
     
    subject: What UML diagram to design a Framework