Sorry Yang, one further thought on the UML diagram is that you have labelled the link between DataObject and ChangeSummary as "changeSummary", which might lead the user to think that changeSummary is an instance member of DataObject and that they could somehow simply trigger a non-null instance to be present in an arbitrary DataObject by perhaps calling getChangeSummary(). This runs counter to the facts that a given DataObject instance can be associated with a ChangeSummary indirerctly through the containment hierarchy, and that there must be a property of ChangeSummaryType in the Type of the DataObject, which may or may not be called changeSummary, before it can directly contain a ChangeSummatry instance.
An alternative would perhaps be that we could edit the compartment of the uml block for DataObject and make some key methods visible, such as getChangeSummary(), I guess its possible that this approach might address my concern about the value(s) class too, in that we could add a few get*(*) methods to the DataObject's compartment, but that might become messy. Cheers, Kelvin. On 27/09/06, kelvin goodson <[EMAIL PROTECTED]> wrote:
Hi Yang, thanks for that. A few comments ... - i agree with Luciano that we are trying to get too much on the overview page - it would be nice to take more control of the layout, particularly so that the single lines of text associated with images are clearly associated with those images and maybe stand out a bit more (perhaps using a table and controlling the sizes of the images to match up could help here) - I worry about using the "value(s)" class in the UML diagram, and then leaving that unqualified (no link from that UML block). Technically Object would be better, but still leave the reader not much wiser and it doesn't get over the picture that this is the association by which the graph of DataObject's is built up as well as that by which simple property values are held. - It would be good to see Sequence in the UML diagram Cheers, Kelvin. On 27/09/06, Yang ZHONG < [EMAIL PROTECTED]> wrote: > > I've just attached a demo into > http://issues.apache.org/jira/browse/TUSCANY-751 > > Please review by unzip > > http://issues.apache.org/jira/secure/attachment/12341763/NewSdoOverview.zip > > and use a browser to open sdo_index.html; > the overview diagram can be clicked into respective introduction. > > Looking forward to your inputs and I'll incorporate them. > > Thanks. > > On 9/22/06, Yang ZHONG < [EMAIL PROTECTED]> wrote: > > > > Thank Andrew for the support > > and thank Kelvin and Geoff for the text contribution. > > > > I propose this brief description right after "SDO is a natural format > > ...": > > > > "SDO provides flexible data structures that allow data to be organized > > as graphs of objects (called data objects) that are composed of > > properties. Properties can be single or many valued and can have other > > > data objects as their values. A data object can maintain a change > > summary of the alterations made to it, providing efficient > > communication of changes and a convenient way to update an original > > data source. SDO naturally permits disconnected data access patterns > > with an optimistic concurrency control model. Change summaries are > great > > for doing roll-back too." > > > > "SDO offers a convenient way to work with XML documents. SDO > > implementations provide helpers to populate a data graph from both XML > > documents and relational databases and also to read SDO metadata from > > an XML Schema Definition (XSD). Data objects can be serialized to XML > > and the metadata can be serialized to an XSD file." > > > > And I propose this structural diagram clickable towards brief > DataObject, > > Type, Property and ChangeSummary description: > > > http://issues.apache.org/jira/secure/attachment/12341428/overview.gif > > > > As for DataObject brief description page, I propose > > > > "Data objects are composed of > > properties. Properties can be single or many valued and can have other > > data objects as their values. A data object can maintain a change > > summary of the alterations made to it." > > > > with this diagram: > > > > > http://issues.apache.org/jira/secure/attachment/12341426/DataObject.gif > > > > As for Type brief description page, I propose > > > > "Type is the model of DataObject. Type is composed of Properties, > > also Type inherits Properties from base Types." > > > > with this diagram: > > http://issues.apache.org/jira/secure/attachment/12341429/type.gif > > > > As for ChangeSummary brief description page, I propose > > > > "ChangeSummary provides efficient > > communication of changes and a convenient way to update an original > > data source. SDO naturally permits disconnected data access patterns > > with an optimistic concurrency control model. Change summaries are > great > > for doning roll-back too." > > > > with this diagram: > > > > http://issues.apache.org/jira/secure/attachment/12341430/ChangeSummary.gif > > > > > As for Property brief description page, I propose > > > > "A Property can be single or many valued, and value has a Type. > > A Property can specify a default value." > > > > with this diagram: > > > http://issues.apache.org/jira/secure/attachment/12341425/property.gif > > > > > > On second thought, maybe the linked description pages doesn't have to > be > > brief. > > What do you think and what do you propose if we can put more > description > > there please? > > > > Looking forward to your inputs and I'll incorporate them. > > > > Thanks. > > > > > > -- > > > > Yang ZHONG > > > > > > -- > > Yang ZHONG > >
