How do you document EJBs?

I want to document my EJB client-wise, meaning that I need docs for users of
my EJBs. I used to write javadocs comments for interface and home classes.
But I use JBuilder and those classes are being regenerated often. How do you
document your EJBs?

"GD" <[email protected]> wrote in message news:[email protected]..
I want to document my EJB client-wise, meaning that I need docs for users of
my EJBs. I used to write javadocs comments for interface and home classes.
But I use JBuilder and those classes are being regenerated often. How do you
document your EJBs?I'd look for documentation options in the JBuilder
setup. I don't beleive there is no one.
Regards,
Slava Imeshev

Similar Messages

[Java and all else] How do you document DB design?

Hello,
Although most of the technical choices are explicit in SQL (UniqueKey & ForeignKey constraints, indexes,...), the semantics of the data columns and their constraints seem better served as plain human-readable comments ("ID column: identifies the plane copy; 6 figures are enough as we don't expect to sell more than 1 million planes in a foreseeable future...").
In my current system, (EJB-based, but the DB schema is not created by the JPA-compliant ORM, but via SQL scripts), I see the following ways to write and maintain this documentation:
- SQL comments in the schema creation and patch scripts
- Javadoc comments in the Java source of the Entity classes.
- UML notes in UML diagrams(1)
- external "Architecture and design" document.
All 4 of them are used, sometimes inconsistently, for various parts of the design choices; I mean, the docs do not contradict themselves (not yet, but it's a mere question of time), but some tables are commented in SQL scripts, others are in design docs, and the details for some columns are in entity javadocs. Although each developer may find it handier to "write" the doc via his preferred medium, it becomes increasingly difficult to "maintain" theoverall documentation.
Our current situation is that most of the project team members are Java developers, so it would probably be better accepted and served if we standardized that we document DB tables and columns in Java source, but I am worried that:
- someone else pouring over our DB (ex: DBA helping us to optimize things, or other team developping a data-mining tool to leverage the historical data in DB) may not be as comfortable with Java
- this may not cover all design choices of the DB schema:
- - - - first, although that is the case currently, in the future there might not be a 100% 1-1 mapping between e.g. each entity class and a DB table. Maybe some columns will not need to be mapped anymore,...
- - - - second, I fear some DB constructs are not amenable to Java counterparts; no accurate idea there, I'm not an SQL nor JPA expert, but I presume Indexes, table partitioning, tablespaces, for example (yes, the DBMS is Oracle :o) are not taken into account in JPA mapping.
And if we document those choices at the SQL level (my preferred idea so far), this will gradually make the javadocs in the entities obsolete, or removed altogether, and that will make future maintenance of the Java source risky.
How do you document your DB design in general?
Do you have specific advices for my case?
Thanks in advance,
J.
(1) Just for the record, here are a few posts that refer to modelling the DB in UML:
[A post on this forum highlighting that UML 1.4 standardizes a notation for RDB modelling|http://forums.sun.com/thread.jspa?messageID=1383724#1383724]
[A DB modelling tutorial|http://www.tomjewett.com/dbdesign/dbdesign.php] (not sure whether it leverages the standard mentioned above :o)
P.S.: "Java and all else" as in, damn, I'd love to use the familiar JDC forums and people to discuss not only Java-related issues, but also [all other things that surround Java|http://forums.sun.com/thread.jspa?threadID=5422264&tstart=0] (other technologies, processes, people) and enable to make workable systems out of Java code.

jduprez wrote:
Thank you again.
A couple more questions:
2. Table, and proc dictionary maintained as one or more text files. Those files and schema are all in source control.Do you mean, a proprietary text format (a la tabledesign.txt), or +.sql+ source files? Again, you seem to suggest the scehma info is present in two locations.I didn't say two locations unless you meant files. Then yes.Yes I meant two files. I trust the team to get the doc file lagging a few revisions behind the SQL file, and to correct that I would have to include one more step in the review process (e.g. "review CM actions to check that the doc file is updated consistently with the SQL source").
The tool I wrote would throw errors if the comment file didn't match the schema. And if comments were not provided. That of course doesn't stop someone from documenting a table with "a table".
You can of course keep the addtional info as special comments in the SQL, but when I did this, and even in retrospect, it seems better and perhaps easier to keep them seperate. I have done special comments in SQL before and it seems a bit of a kluge but you do have the single source. But in that case I was the only one maintaining it too.What do you mean by "special"?For code generation I have a schema file with the following (pseudo sql.)
    create mytable
       mytable_id int,
       column_foo varchar(10);
       column_fum varchar(20)
        -- Query: for_a_query (column_foo, column_fum)
    )The generator consumes the schema and generates the standard CRUD which would include a query based on the primary key.
The above comment is used to provide an additional query where the proc is named 'for_a_query' (munged with table name) and takes two parameters (column_foo, column_fum) whose type/name matches those of the table.
If we don't try to generate a browseable HTML out of the schema (although the idea is appealing, I don't have the resource to make such a tool), do you see anything kludgy in maintaining SQL comments interpersed within DDL code?
Of course that is doable.

How do you document specific sections of a VI?

Once in a while I'll use a VI (perhaps one of mine or one from vi.lib) to do something in an unusual way. How would you document this usage so that when you go back to it some weeks later you don't have to scratch your head wondering why you did it that way? A free label near that VI (or wire) clutters the diagram and gets lost when doing a diagram cleanup (ctrl-U).
I can think of a couple of ways that NI could help us out. One would be to allow me to attach a documentation property to an instance of a VI or wire. This documentation would show up as either a tool tip when you hover the mouse over the object, or in the Context Help window. An indicator would be needed on the VI or wire to let me know that there is documentation available. The indicator may be something that resembles a coersion dot though in a different location so it won't be confused as a coersion dot.
On a related note, I've seen a few diagrams that have transparent labels on top of a wire indicating what that wire does. This is a pretty good kludge to document a wire. Perhaps a label property can be attached to the wire in much the same way as the documentation property I describe above. The label would be visible and automatically displayed on top of the wire. The key difference is that the label would be owned by the wire and could not get misplaced.
- les

I like the way NI documents code in some of their examples. They use small labels with a number or letter in it. Then below is a huge label with explanations of each numer of letter. See the picture:
Message Edited by tbob on 09-23-2008 12:27 PM
- tbob
Inventor of the WORM Global
Attachments:
Dynamic Generation and Acquisition-Source Synchronous_BD.png ‏18 KB

How do you document ABAP programs?

hi
How do you document ABAP programs? Do you use program documentation menu option?
Regards
Ashok Kumar

Hi,
good for selection screens:
when in the ABAP Editor, in edit mode, choose
Goto->Documentation.
This gives you a SAPscript-type screen with many headings. Enter the instructions that you want your end-user to see when they run the program. SAP supplies many different headings here, choose the ones relevant to your program.
Save and activate.
When you run your program, when you are at the selection screen, choose
Help->Application Help
and you see your user documentation!
I expect Sapscript experts can make this look even better, with links to other help topics etc.
Regards

How Do You Document a Song

Hope this isn't a repost, but I am curious if there is a way to capture a song's information (including plugin settings, track names, audio driver parameters) in some sort of human readable format? I am trying to be better at documenting my studio work and would love an automated way of generating this type of information. Thanks.
Dual 2 GHz G5 w/ 2.5 GB RAM Mac OS X (10.4.4) Logic Pro 7.1, iLife '06, BBedit 8.2.4, Pro Tools LE 7

As for an automated way to list out all of your plugs, patches, etc., I don't know of anything like that.
Aside from saving songs as projects as the most complete "internal" record of your work, document things with paper and pen. It's really the most expedient way to do things. Make track sheets, crosspatching worksheets (if you have a patchbay) and keep all of your paperwork filed along with backup copies of your disks. Some of my projects generate lots of paperwork, including scores, and they end up in individual banker's boxes (file folder boxes).
Or do the same kind of documentation in Excel or Word and save those files in your project folder. Make backups.
You can also take screenshots of critical information and store that stuff in with your project folder as well. I do this on a regular basis, to keep track of preference settings.

How do you run EJB client?

If you are using a java application to test the bean you can run it from the command prompt as you run the other java programmes. If you are accessing it through a jsp page or servlet you need a webserver. If possible tell me what client you are using.([email protected])
Mahe

How do you HYPERLINK a web page address to an EXCEL document in Firefox like is possible in Explorer

How do you HYPERLINK a web page address to an EXCEL document in Firefox like is possible in Explorer?

When you follow a hyperlink in Excel, usually it should open in your default browser. You shouldn't have to do anything special in Excel to create the link when Firefox is your default browser compared with IE. However, the Insert Hyperlink dialog might work differently. I think it might be able to automatically pre-populate a URL from IE, while in Firefox, you need to copy the URL from Firefox's address bar and paste it into the Insert Link dialog.

How do you highlight multiple documents rapidly, rather than having to click on the document and on "command" one at a time?

How do you highlight multiple documents rapidly, rather than having to click on the document and on "command" one at a time? Right now, when I'm trying to highlight documents to export, I have to click on each document individually. Is there a way to highlight one document while scrolling down the list until all desired documents are highlighted? I would like to rapidly be able to do this to save time when I am exporting or saving multiple files from my documents to an external drive, CD-Rom or cloud storage.

Click on the first item
Hold the Shift key
Click on the Last Item.
All the items in between will be selected.

How do you apply a master page to multiple documents at the same time?

How do you apply a master page to multiple documents at the same time?

Hi friends,
Thank you for trying to help me out.
Let me explain it a bit to remove the ambiguity.
I have 10 documents nested under a book. Each of these documents have 'n' number of pages. I want to apply my custom made master page "First" to the first page of all these 10 documents in one go. The remaining pages of the documents have to be in default "Right" master page format. How will I do it?
I tried selecting all the documents and importing the formats from another document with the custom made "First" master page. The master page format is getting imported but the first page of all the documents still remain with the default "Right" master page format.
I think now my question is more clear...

How do you merge multiple pdf's into one document?

How do you merge multiple pdf's into one document?

Hi pharmovative,
You can use the Combine PDF feature of Adobe PDF pack to combine multiple PDF files into one document. (Or, if you have the full version of Acrobat, you an do it there as well by choosing Create > Combine Files into a Single PDF.)
Please let us know if you need further assistance.
Best,
Sara

In print preview - how can you have multipage previews of the document - 1 - 2 - 3- 6 - 12 page preview and so on so that you can see if the document is ok to print?

WINXP - In Explorer you can have multi-page print previews from 1, 2, 3, 6 upwards to check and confirm that the document will print correctly to your needs - and does this across the screen format as opposed to down the page, so that you can see all 12 pages on your screen to quickly see that the print percentage is correct and all pages fall into the print area and so on - how can you set this up with Firefox, because printing with Firefox is so unstable, you don't know what to expect when printing a document or web page?

No what I mean is how can you see many pages across the screen without having to scroll like in explorer where you can see 12 or more small pages on your screen without scrolling down, like tiled across your screen as opposed to vertical down the page. Thanks

How do you convert a PDF document to a word document ?

How do you convert a PDF document to a word document ?

I just noticed that you added a few more details and it seems like the problem is that part of the conversion is not working. Would it be possible to share the file with me so that I can forward it to the team that owns that service? My email address is [email protected]
Thanks!
Pat

How do you reverse a goods receipt document of a service entry sheet?

Hi SAP experts,
How do you reverse a goods receipt document of a service entry sheet? Your help/opinions will be highly appreciated. Thanks!
Jessica Mari C. Cruz
Jr. Software Development Analyst
SAP- Materials Management Team

You can sue the ML81N itself to delete the service entry sheet and once you will delete the SES, system will generate the Material document for reversal of GR.
Go to ML81N and enter the service number and change the screen to change mode.
If release statergy is used for this then cancel the release using the same statergy.
Click Revoke acceptance button or Ctrl + F2.
Edited by: Manish Kumar Agarwal on Aug 4, 2009 8:27 AM

How Do You Drag A Document You Have On A Mac Onto An External HardDrive??

Ive just recently bought a Macbook Pro and was wondering how can you drag a document onto an external hard drive. Is it the same as Windows?? Because everytime I try that, it wont let me :s.
If anyone could help it would be awesome because I need to know how to do this so I can put my cousework I have done on my MacBookPro, onto my external hard drive.
Thanks
Carol-Anne

Your external drive is likely formatted NTFS.
Take the drive to the PC and remove all the data on it and right click on it and format it exFAT or FAT on the PC, then place the files back on.
(Formatting a drive will remove all data on it.)
Take it to the Mac and it can use it just fine.
No need to buy any software, it will have to be constantly updated and tends to cause problems and glitches.
Drives, partitions, formatting w/Mac's + PC's

How can you create a writable PDF document from a PPT presentation ?

How can you create a writable PDF document from a PPT presentation ? Upper part with the image , lower part with a free space in order to take notes for students during presentation or course.
Thanks.
B

You can make a PDF file out of you notes and handouts but using the Adobe PDF printer.
Open your PowerPoint Document then go to “File” “Print”
Select ‘Adobe PDF” Printer
Under slides, select which way you want to print. Note it will not print to a printer but to a PDF file.
After then go into printer Properties and Setup PDF properties, do the following: (see second image below)
Default: PDF/A 1-b
Adobe Security: none (change as needed)
Adobe Output folder: Prompt for Adobe file name
Adobe Page size: Letter (change as needed)
Check the following check boxes
View Adobe PDf Results,
Add Document Information,
Rely on system fonts only,
Delete Log files for successful jobs.
Select OK
A pop will ask you where you want to save the document. The file extension should be PDF. After giving the file name select okay and the file should popup as a PDF. Down side is if you want to speaker notes included then you will have to do another file, like wise with just screen shots then combine into one PDF document.
I used Acrobat IX Pro. So to do this you need Acrobat IX or X Pro.
Hope this will help.
Tiger26

How do you document EJBs?

Similar Messages

Maybe you are looking for