Versions Compared

Version Old Version 19 New Version 20
Changes made by

Niamh Core

Niamh Core

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Description

Details

Decisions

1Assume flat attributes (no complex data types) but data could be stored as json object in SPI impl. for convenience/PoC

2SPI Implementation NOT using Model (service) current ENM SPI does!

3Are we going to have XPath/query builder?
  • We should decide based on what the users want to use/is easy to use
  • We don't want a query builder that eventually mimics XPaths functionality, use what is defined already XPATH as a based but maybe supplement with a xpath-builder

4When do we get attributes?

How do control how many attributes we get back?

We will have an (optional) output specification with the following options

  1. Default is no attributes 
  2. All Attributes
  3. Specify attributes - output specification (filter)
5Should we use the name node or fragment?
We decided on the name DataNode
6Do we want to split the interface? 

Maybe we could just have a 

3 Alternatives 

  1. all in one interface
  2. Limited number of interfaces e.g Data Objects/ Data Persistence/Query
  3. Very fine grained (see below)
  1. DataStore SPI - methods to add data. 
    e.g dataStore.addChild(parentDataObject, childDataObject)
  2. CpsAdmin Interface will handle the dataspaces and anchors
  3. Module SPI - responsible for handling modules and module sets

The above will be in separate maven modules. Any data object they need will be in the same module.

We will not have a querybuilder in SPI but the SPI will have to understand the cpsPath. The java API will use a builder pattern to create a cpsPath

7Do we need objects for very simple concept like dataspaceName which are just a string?
  • We will not use objects for name fields. We will just use Strings.
  • We may need an object for AnchorName
8Should we share common objects between the Java API and SPI?

Alternatives

  1. API depends on model objects defined in SPI
  2. SPI depends on model objects defined in API
  3. Extract common model API in separate module (deliverable)
  4. Use separate models with slightly different names e.g Anchor in API and AnchorDetails in SPI (CPService will transfer when needed)

ENM SPI Study

Details about the ENM SPI can be found here: ENM Study

...