Robbie and I discussed on the 'phone my comments so far on the samples in the attached spreadsheet. I'm pasting the contents below for generality too. (I'm hoping that these will paste back into the bookmarks view of your eclipse environment Robbie.)
A couple of points that we thought might be worth picking out are
1) how best in general to ensure that the user has a good experience with regards to class path and resource finding issues when first running these samples. Currently Robbies top level program has source code comments on how to ensure the class path is right, but its not only jars that need to be on the class path, but resources such as the xml and xsd files. I had to fix up my environment before I could get it running. I guess we should be catering for the lowest common denominator here, and assuming only a shell/command window + a jvm. Any thoughts on packaging of these samples would be welcome?
2) Robbie's sample has a top level manager which will step by step execute all the samples. Many editors and SDKs will interpret strings of a certain format as links into the code (e.g. when an exception prints to the console you can often click on a line in the exception and jump to the text in the code). I suggested printing such a link from the main() methods of each sample program, to allow the user when stepping through the sequence of programs to jump to the code of the sample they are running, e.g.
private static void defineCompanyTypes() throws Exception {
System.out.println("Defining Types using XSD");
System.out.println("org.apache.tuscany.samples.sdo.otherSources.CreateCompany.defineCompanyTypes (CreateCompany.java:60)");
.....
any comments?
| Description | Resource | Path | Location |
| SAMPLES: fragile, requires careful set up, does this work on the command line | CreateDataObjectFromXsdAndXmlFiles.java | sample-sdo/src/main/java/org/apache/tuscany/samples/sdo/specCodeSnippets | line 67 |
| SAMPLES ;-) | ExecuteSamples.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo | line 52 |
| SAMPLES: are these relative links fragile, is there any robust way to ensure these work across environments | SdoSampleConstants.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo | line 30 |
| SAMPLES: including ... | ExecuteSamples.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo | line 61 |
| SAMPLES: maintenance issue -- point to web doc for instructions? | ExecuteSamples.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo | line 35 |
| SAMPLES: sp (is pp in snipets uk english?) + others | ExecuteSamples.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo | line 59 |
| SAMPLES: i don't understand your comment. Is there a bug? | CreateCompany.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 161 |
| SAMPLES: seems odd for a sample to have main at the bottom | CreateCompany.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 98 |
| SAMPLES: would be nice to have some confirmation that the file was saved at the location | PurchaseOrderCmdLine.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 63 |
| SAMPLES: * @see COMPANY_GENERATED_XML ??? | CreateCompany.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 42 |
| SAMPLES: <CR> causes exception, null input or other error input should be == "1" (with bad input message?) | PurchaseOrderCmdLine.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 120 |
| SAMPLES: should the @link do something here? | CreatePurchaseOrder.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 52 |
| SAMPLES: sp | CreateCompany.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 40 |
| SAMPLES: SP | PurchaseOrderCmdLine.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 324 |
| SAMPLES: SP | ReadPurchaseOrder.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 50 |
| SAMPLES: suggest including interpretable link | CreateCompany.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 60 |
| SAMPLES: what is the source of this sample? can we ref it? | CreateCompany.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/otherSources | line 18 |
| SAMPLES: I think rjm is filling out this test case --- check | AccessDataObjectUsingValidXPath.java | samples-20060808/src/main/java/org/apache/tuscany/samples/sdo/specCodeSnippets | line 62 |
On 08/08/06, Robbie Minshall <
[EMAIL PROTECTED]> wrote:
Hi.
I made an update ( updated overview for javadoc ) for the SDO Samples.
There are still a few toDo's here that I am going to work on when I find
some time tomorrow ( namely a better xpath sample ) but things are getting
there. Could a commiter ( or anyone else interested) have a look at these
and provide me with some feedback on what they would like improved or
adjusted prior to commiting these.
I uploaded a zip of the project at :
http://wiki.apache.org/ws-data/attachments/Tuscany(2f)TuscanyJava/attachments/SDO%20Samples%202006%2008%2008 <[email protected]>
thanks very much,
Robbie
--
* * * Charlie * * *
Check out some pics of little Charlie at
http://www.flickr.com/photos/[EMAIL PROTECTED]/sets/
* * * Addresss * * *
1914 Overland Drive
Chapel Hill
NC 27517
* * * Number * * *
919-225-1553
--
Best Regards
Kelvin Goodson
comments060808.xls
Description: MS-Excel spreadsheet
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
