Re: RIM edits: metadata

[Farrukh Najmi <Farrukh.Najmi@east.sun.com>]

Jon,

Thanks for your careful compilation of the areas where content and
metadata are confused. I will carefully go through and incorporate the
changes you have suggested. This should be a great improvement to the
readability and understandability of the document.

--

Regards,
Farrukh

Jon Bosak wrote:

> [I sent this on Sunday, but now I see that it bounced for some
> reason.]
>
> Date: Sun, 7 Jan 2001 22:47:16 -0800 (PST)
> From: Jon Bosak <bosak@boethius.eng.sun.com>
> To: ebxml-regrep@lists.ebxml.org
> Subject: RIM edits: metadata
>
> The RIM spec fails in some places to properly distinguish between
> content and metadata.  I have undertaken in the following to
> identify the places where there appears to be confusion on this
> and to provide language that resolves it.  However, since I am
> neither an OO programming expert nor a UML expert, it's quite
> possible that I have misinterpreted some of the passages, so the
> edits suggested here will have to be carefully reviewed before
> incorporating them into the spec.
>
> The source language in all cases is taken from version 0.52 dated
> 2000.12.27, which is the latest I had when I started this task.
>
> In what follows, I have cited each passage from the source with
> its line number or figure reference and then followed it with a
> proposed revision.
>
> To avoid excess verbiage, I have used the construction "x
> catalogues y" to mean "x associates descriptive metadata with y".
>
> Jon
>
> ##################################################################
>
> ITEM: Figure 2 ("ebXML Registry & Repository"), label on "Object"
>
> ##################################################################
>
> CURRENT WORDING
>
> Any content in registry that has a unique identity is an
> object. [...]
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> Objects in the registry are collections of metadata. [...]
>
> ##################################################################
>
> ITEM: Figure 2 ("ebXML Registry & Repository"), label on
> "Intrinsic Object"
>
> ##################################################################
>
> CURRENT WORDING
>
> Content whose type is known to the Registry
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> Metadata describing content whose type is known to the Registry
>
> ##################################################################
>
> ITEM: Figure 2 ("ebXML Registry & Repository"), label on
> "Extrinsic Object"
>
> ##################################################################
>
> CURRENT WORDING
>
> Content whose type is not known to Registry
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> Metadata describing content whose type is not known to the
> Registry
>
> ##################################################################
>
> ITEM: lines 384-387
>
> ##################################################################
>
> CURRENT WORDING
>
> The ManagedObject class models a common base class for all
> submitted content whose life cycle is managed by the
> registry. Content submitted to the registry is further specialized
> by ExtrinsicObject and IntrinsicObject sub-classes of
> ManagedObject.
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> ManagedObject is a common base class for all metadata describing
> submitted content whose life cycle is managed by the
> registry. Metadata describing content submitted to the registry is
> further specialized by the ExtrinsicObject and IntrinsicObject
> subclasses of ManagedObject.
>
> ##################################################################
>
> ITEM: lines 396-404
>
> ##################################################################
>
> CURRENT WORDING
>
> ExtrinsicObject models all submitted content whose type is not
> intrinsically known to the registry.
>
> Since the registry can contain arbitrary content without
> intrinsic knowledge about that content, ExtrinsicObjects require
> special metadata attributes to provide some knowledge about the
> object (e.g. mime type).
>
> Examples of content modeled by ExtrinsicObject include party
> profiles, business process descriptions, schemas, etc.
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> ExtrinsicObjects catalogue submitted content whose type is not
> intrinsically known to the registry and therefore must be
> described by means of additional attributes (e.g., mime type).
> Examples of content catalogued by ExtrinsicObject include party
> profiles, business process descriptions, and schemas.
>
> ##################################################################
>
> ITEM: table beginning at line 411
>
> ##################################################################
>
> CURRENT WORDING
>
> static int OBJECT_TYPE_PARTY_AGREEMENT
>
> These are XML documents that represent a technical agreement
> between two parties on how they plan to communicate with each
> other in a specific B2B protocol.
>
> static int OBJECT_TYPE_PARTY_PROFILE
>
> These are XML documents that provide information about a party
> interested in participating in B2B interaction.
>
> static int OBJECT_TYPE_PROCESS
>
> A process description document.
>
> static int OBJECT_TYPE_ROLE
>
> An XML description of a Role in a Collaboration Party Profile
>
> static int OBJECT_TYPE_SERVICE_INTERFACE
>
> An XML description of a service interface
>
> static int OBJECT_TYPE_SOFTWARE_COMPONENT
>
> A software component (e.g. EJB, class library etc.)
>
> static int OBJECT_TYPE_TRANSPORT
>
> An XML description of a transport configuration Collaboration
> Party Profile
>
> static int OBJECT_TYPE_UML_MODEL
>
> A UML Model
>
> static int OBJECT_TYPE_UNKNOWN
>
> An unspecified objectType.
>
> static int OBJECT_TYPE_XML_SCHEMA
>
> A schema (DTD, XML Schema, Relax, etc.) for an XML document
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> static int OBJECT_TYPE_PARTY_AGREEMENT
>
> An ExtrinsicObject of this type catalogues an XML document
> representing a technical agreement between two parties on how they
> plan to communicate with each other using a specific protocol.
>
> static int OBJECT_TYPE_PARTY_PROFILE
>
> An ExtrinsicObject of this type catalogues an XML document that
> provides information about a party participating in a business
> transaction.
>
> static int OBJECT_TYPE_PROCESS
>
> An ExtrinsicObject of this type catalogues a process description
> document.
>
> static int OBJECT_TYPE_ROLE
>
> An ExtrinsicObject of this type catalogues an XML description of a
> Role in a Collaboration Party Profile.
>
> static int OBJECT_TYPE_SERVICE_INTERFACE
>
> An ExtrinsicObject of this type catalogues an XML description of a
> service interface.
>
> static int OBJECT_TYPE_SOFTWARE_COMPONENT
>
> An ExtrinsicObject of this type catalogues a software component
> (e.g., an EJB or class library).
>
> static int OBJECT_TYPE_TRANSPORT
>
> An ExtrinsicObject of this type catalogues an XML description of a
> transport configuration.
>
> static int OBJECT_TYPE_UML_MODEL
>
> An ExtrinsicObject of this type catalogues a UML model.
>
> static int OBJECT_TYPE_XML_SCHEMA
>
> An ExtrinsicObject of this type catalogues an XML schema (DTD, XML
> Schema, RELAX grammar, etc.).  [just a single type for all?]
>
> static int OBJECT_TYPE_UNKNOWN
>
> Signifies that the ExtrinsicObject catalogues content whose type
> is unknown.
>
> ##################################################################
>
> ITEM: lines 420-422
>
> ##################################################################
>
> CURRENT WORDING
>
> IntrinsicObject provides a common base class for modeling all
> submitted content whose type is known to the Registry. In fact,
> these types are defined by the ebXML registry specifications.
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> IntrinsicObjects catalogue submitted content whose type is known
> to the Registry and defined by the ebXML registry specifications.
>
> ##################################################################
>
> ITEM: lines 431-437
>
> ##################################################################
>
> CURRENT WORDING
>
> ExternalLink instances model a named URI to content that may
> reside outside the registry.
>
> Consider the case where a Submitting Organization submits a
> managed object content (e.g. a DTD) and wants to associate some
> external content to that object (e.g. the Submitting
> Organization's home page). The ExternalLink enables this
> capability.
>
> ------------------------------------------------------------------
>
> SUGGESTED REPLACEMENT
>
> ExternalLinks use URIs to associate content in the registry with
> content that may reside outside the registry.  For example, an
> organization submitting a DTD could use an ExternalLink to
> associate the DTD with the organization's home page.

--
Regards,
Farrukh

begin:vcard 
n:Najmi;Farrukh
tel;work:781-442-0703
x-mozilla-html:FALSE
url:www.sun.com
org:Sun Microsystems;Java Software
adr:;;1 Network Dr. MS BUR02-302;Burlington;MA;01803-0902;USA
version:2.1
email;internet:najmi@east.sun.com
fn:Farrukh Najmi
end:vcard