Author Topic: How to describe file formats in UML? (e.g. BNF) (Read 15767 times)

OwenInCanada · « **on:** April 29, 2009, 12:13:41 am »

Hi all,

In my software design in EA, I have the need to document some binary file formats. These can be described, for example, in Backus–Naur Form (BNF). Is there a natural place in an EA project to put some BNF? Or is there a technique other than BNF that serves the same purpose in UML?

One technique is to put a big Note on my diagram and capture my BNF phrases there. Any other ideas?

Thanks,

Owen

FPreiss · « **Reply #1 on:** April 29, 2009, 06:40:44 pm »

I never tried to express BNF with UML, but I found the topic very interesting, so I did a little web research and stumbled across this article: http://csci.csusb.edu/dick/papers/rjb99c.umlpl.html

Perhaps it will help you.

Paolo F Cantoni · « **Reply #2 on:** April 30, 2009, 10:58:55 am »

Quote

I never tried to express BNF with UML, but I found the topic very interesting, so I did a little web research and stumbled across this article: http://csci.csusb.edu/thingy/papers/rjb99c.umlpl.html

Perhaps it will help you.

I'm getting a 404 - Not found

Can anyone else get through?

TIA,
PAolo

KP · « **Reply #3 on:** April 30, 2009, 11:05:21 am »

Quote

Quote
I never tried to express BNF with UML, but I found the topic very interesting, so I did a little web research and stumbled across this article: http://csci.csusb.edu/thingy/papers/rjb99c.umlpl.html

Perhaps it will help you.
I'm getting a 404 - Not found

Can anyone else get through?

TIA,
PAolo

I spot a 'thingy' in that URL. I think the forum's rude word substitution has been triggered. Replace 'thingy' with a diminutive for 'Richard' and you'll get there...

Paolo F Cantoni · « **Reply #4 on:** April 30, 2009, 03:29:24 pm »

Quote

I spot a 'thingy' in that URL. I think the forum's rude word substitution has been triggered. Replace 'thingy' with a diminutive for 'Richard' and you'll get there...

Ahh... I wondered about that!

Works a treat!

Thanx!

Frank Horn · « **Reply #5 on:** April 30, 2009, 04:42:25 pm »

This YaBB censorship is a bugger indeed. Bleeding yankee crap. Changing links and code...

OwenInCanada · « **Reply #6 on:** May 01, 2009, 05:20:19 am »

Thank you for that pointer.

So long story short:

EA is both a UML tool and more generally a software design tool.

While file formats may not be well captured in UML according to that link, surely file formats are part of my software design.

Sooo.... my solution is the following kluge:
Take my BNF (which is only a couple of dozen lines) and copy it into a note on an EA diagram. This serves the purpose of centralizing my design in one tool. But there is no formal connection between the BNF content and the EA models.

Thanks again for your input.

Regards,

Owen

Sunshine · « **Reply #7 on:** June 30, 2009, 09:06:41 pm »

An alternative is to use an artifact and store the BNF in the notes field. That way you can reference it in other diagrams if required.

Thomas Mercer-Hursh · « **Reply #8 on:** July 01, 2009, 07:54:51 am »

How about creating them in a Requirements Diagram?

Sparx Systems Forum

News: