[jira] Created: (TUSCANY-1283) Better organization of the interfaces and classes in the SDO Java project

2007-05-14 Thread Frank Budinsky (JIRA)
Better organization of the interfaces and classes in the SDO Java project
-

 Key: TUSCANY-1283
 URL: https://issues.apache.org/jira/browse/TUSCANY-1283
 Project: Tuscany
  Issue Type: Improvement
  Components: Java SDO Implementation
Reporter: Frank Budinsky
 Fix For: Java-SDO-Mx


Currently, there is no clean separation between client API vs. implementation 
(internal) classes. There's also no separation between the EMF-dependent and 
independent parts of the RT.

We have been recommending clients stick to standard SDO APIs (from the spec) 
and for anything else use class SDOUtil, which is where we put all the required 
extensions that people have requested. One other interface, XMLStreamHelper 
(for working with StAX streams) is the only other interface in Tuscany that 
clients are expected to use directly.

So, clients that are only using standard SDO APIs, SDOUtil, and 
XMLStreamHelper, should be unaffected by the reorganization for now, because we 
will keep deprecated versions of SDOUtil and XMLStreamHelper around for a 
while, but we would like to move them to a better package and have clients 
gradually move to the new ones.

Here is the concrete plan:

package org.apache.tuscany.sdo.api (all client API will be under this package)
SDOUtil (new one)
XMLStreamHelper (new one)
other new things ...

package org.apache.tuscany.sdo.rtemf (EMF-based runtime implementation classes)
subset of existing classes (most of them) that have EMF dependencies
(these are existing packages just moved down one level, e.g., 
org.apache.tuscany.sdo.helper -> org.apache.sdo.tuscany.sdo.rtemf.helper)

package org.apache.tuscany.sdo.rtlib (common runtime implementation classes)
subset of existing classes that have no EMF dependencies

package org.apache.tuscany.sdo.util (deprecated)
SDOUtil (deprecated - clients should switch to 
org.apache.tuscany.sdo.api.SDOUtil)

package org.apache.tuscany.sdo.helper (deprecated)
XMLStreamHelper (deprecated - clients should switch to 
org.apache.tuscany.sdo.api.XMLStreamHelper)


-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: [jira] Created: (TUSCANY-1283) Better organization of the interfaces and classes in the SDO Java project

2007-05-21 Thread ant elder

Kind of related to this JIRA, could the spec/sdo-api module be moved in the
SVN repo from tuscany/java/spec/sdo-api to tuscany/java/sdo/api?

  ...ant

On 5/14/07, Frank Budinsky (JIRA)  wrote:


Better organization of the interfaces and classes in the SDO Java project
-

 Key: TUSCANY-1283
 URL: https://issues.apache.org/jira/browse/TUSCANY-1283
 Project: Tuscany
  Issue Type: Improvement
  Components: Java SDO Implementation
Reporter: Frank Budinsky
 Fix For: Java-SDO-Mx


Currently, there is no clean separation between client API vs.
implementation (internal) classes. There's also no separation between the
EMF-dependent and independent parts of the RT.

We have been recommending clients stick to standard SDO APIs (from the
spec) and for anything else use class SDOUtil, which is where we put all the
required extensions that people have requested. One other interface,
XMLStreamHelper (for working with StAX streams) is the only other interface
in Tuscany that clients are expected to use directly.

So, clients that are only using standard SDO APIs, SDOUtil, and
XMLStreamHelper, should be unaffected by the reorganization for now, because
we will keep deprecated versions of SDOUtil and XMLStreamHelper around for a
while, but we would like to move them to a better package and have clients
gradually move to the new ones.

Here is the concrete plan:

package org.apache.tuscany.sdo.api (all client API will be under this
package)
SDOUtil (new one)
XMLStreamHelper (new one)
other new things ...

package org.apache.tuscany.sdo.rtemf (EMF-based runtime implementation
classes)
subset of existing classes (most of them) that have EMF
dependencies
(these are existing packages just moved down one level, e.g.,
org.apache.tuscany.sdo.helper -> org.apache.sdo.tuscany.sdo.rtemf.helper)

package org.apache.tuscany.sdo.rtlib (common runtime implementation
classes)
subset of existing classes that have no EMF dependencies

package org.apache.tuscany.sdo.util (deprecated)
SDOUtil (deprecated - clients should switch to
org.apache.tuscany.sdo.api.SDOUtil)

package org.apache.tuscany.sdo.helper (deprecated)
XMLStreamHelper (deprecated - clients should switch to
org.apache.tuscany.sdo.api.XMLStreamHelper)


--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]