Versions Compared

Version Old Version 9 New Version Current
Changes made by

Niamh Core

Niamh Core

Saved on

Key

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

Table of Contents
maxLevel4

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDKCPS-275237


Decisions/Open Issues

Warning
titleDecoupling

It is very important that the SPI doesn't expose any database implementation for example database ID's



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
sa
  • as a based but maybe supplement with a xpath-builder

4

Having a fluent interface in my opinion would be way more intuitive and practical. E.g.

//AND of two restrictions

Restriction and(Restriction firstRestriction,  Restriction secondRestriction)

//OR of two restrictions

Restriction or(Restriction firstRestriction,  Restriction secondRestriction)

//NOT of a restriction

Restriction not(Restriction restriction)

This will give any user of the API an intuitive way to build a complex query and the developer a tree to navigate and translate to SQL (or any other query language). A developer could do something the likes of myQuery.setRestriction(restriction1.and(restrcition2).and(restriction3))
5We have
When do we get attributes?

How do control how many attributes we get back?

Maybe we dont need this because we dont have complex data attributes

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)
6
5Should we use the name node or fragment?
We decided on the name DataNode
/Node
7
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)
peristenceStore
  1. DataStore SPI - methods to add data. 
    e.g dataStore.addChild(parentDataObject, childDataObject)
Change Data SPI to DataStore - methods to add data. 
  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

query.

API - construct the CPS path 

SPI - deconstruct it and convert it into a query  

From an end user perspective anchor and fragment are different - we should separate them 

CpsAdmin Interface will handle the datastore and anchor

access control? extend the CpsAdmin

Module SPI - responsible for handling modules and module sets

QueryBuilder - responsibility of API

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: SpikeENM Study


Interface Proposal

can be found at : Interface Proposal for CPS

Proposed Future Implementation of CPS SPI

...

DataStore SPI


Name

Definition


 Capabilities

1SimpleDataObjectProvides the basic information needed to access an object.
  • getCpsPath
  • getNamespace (see open issue no. 4)
  • getRevision (see open issue no. 4)
  • getSchemaNodeIdentifier (Type)
  • equals
  • hashCode
2DataPersistenceServiceAdding functionality for handling attributes
  • getPersistenceObject

Gets the persistence layer object without any layers of decoration.

If the innermost object is not a persistence layer object then a suitable exception will be thrown.

  • checkUserSuppliedAttributesAtCreation

Passes the attributes supplied by the user for a new persistence object so that they may be verified as required.

  • initializeAttributes

Initializes the attributes for a new persistence object. This method should be invoked when creating a new persistence object rather than using setAttributes() as it will have different behavior, namely:

  1. it verifies all mandatory attributes have been supplied

  2. it initializes all non-supplied attributes to their default value where relevant

  3. no notifications will be sent as a result of this method being called

  • getAttributesSpecificallySet

Gets the values for the attributes which have been specifically set on this object.

This includes attributes which:

  1. were supplied at creation of the object or

  2. had default values applied during creation or

  3. were specifically set after creation by invoking one of the setAttribute(s) methods.

Note that an attribute may have been specifically set to null so the values returned in the map may contain nulls.

  • isAttributeSet

Determines if the supplied attribute has been specifically set (includes attributes which were set to null).

  • getAttributeNames

Gets all of the attribute names available in this persistence object.

  • unsetAttributes

Unsets the values of the supplied attributes.

  • createDataspace
  • getDataspaces
  • getDataspace
  • deleteDataspace
3FragmentObject
4DataspaceObjectCreate a simple CPS Dataspace Object
  • findByName
  • getByName
  • existsByName

Dataspace SPI

...

Definition

...

 Capabilities

...

DataspacePersistenceService

...

  • createDataspace
  • GetDataspace
  • (GetDataspaces)

Fragment SPI

...

Definition

...

 Capabilities

...

FragmentPersistenceService

...

  • getByCpsPath
  • createNode
  • associateNodeToAnchor
  • associateAnchorToDataspace

Module SPI

...

Definition

...

 Capabilities

...

ModulePersistenceService

...

Adding functionality for handling attributes

...

  • getChildren

  • removeAllAssociations

Remove all associations of this persistence object.

  • getNamespace

Retrieves  the namespace of the type of object the type query is to target.

  • storeModule
  • createModuleSet
  • deleteModule
  • getModulesForDataspace
  • getModuleRevisions
  • findByNamespaceAndRevisionAndDataspace
  • associateAnchorToModuleSet
  • createAnchor
  • getAnchors
  • getAnchor
  • deleteAnchor
  • getModuleEntity
  • getDataspace

...

  • getModule
  • getNamespace
  • getType
  • getName
  • getVersion
  • equals
  • hashCode

Query SPI

Name

Service responsible for dealing with query related features of CPS.

Creates a simple restriction (e.g. compare one field to one value).

PartialMatchRestriction

Implementation of the partial match restriction and not match restriction.

  • negate

  • getRestrictionType

  • getRestrictionList

  • getLogicalOperator

  • isNegated

    • toString

    Definition

     Capabilities

    1

     QueryService 

    • execute

    Executes the query and presents the result as an iterator of objects queried for. 

    • executeCount

    Executes the query and presents the result as a count of how many instances are matched against the query.
    Note: because of database limitations, at this moment this method is not optimized.

    • executeDeletion

    Deletes all matching objects and where appropriate deletes any children.

    • getSchemaNodeIdentifier (Type)

    Retrieves the type of object that the type query is to target.

    2

    QueryPathService

    Service responsible for dealing with path query related features

    • executePathQuery

    executes the path query against the db. returns a list of type Object.

    • getTargetObjects

    Executes the query ands gets the result as an iterable of 'full' objects queried. 

    3QueryBuilderServiceCreate queries using CPS query builder

    • getNodesByPathForAnchor

    • getNode

    • queryNodes

    • getNodeBySchemaNodeIdentifier

    4CpsRestrictionCreates a simple CPS restriction
    • pathRestriction
    • getRestriction

    Gets the restriction used in the query criteria, including any internal restrictions added in addition to those set by the user.

    • getAttributeName

    Retrieves the name of the attribute that the restriction is.

    5

    SimpleRestriction

    • negate

    • getAttributeName

    • getAttributeValue

    • getSimpleExpressionOperator

    • toString

    		6

    • negate

    • getRestrictionType

    • getMatchConditionType

    • getAttributeName

    • isNegated

    • getStringToMatch

    • toString

    		7

     LogicalRestriction

    Implement logical restriction (AND/OR) and the negation of this logical restriction.

    		DataStoreService
    • String addDataNode(String dataspaceName, String anchorName, DataNode dataNode);
    • String addDataNode(String dataspaceName, String anchorName, String xPath, DataNode dataNode);​
    • String getCpsPath(String dataspaceName, String anchorName, DataNode dataNode);
    • String getCpsPath(String dataspaceName, String anchorName, DataNode dataNode);
    • DataNode getDataNode(String dataspaceName, String anchorName, String xPathId);
    • Collection<DataNode> queryDataNodes(String dataspaceName, String anchorName, String cpsPath);
    • Collection<DataNode> queryDataNodes(String dataspaceName, String anchorName, String cpsPath, String outputSpecification);
    • Integer count(String dataspaceName, String anchorName, String cpsPath);
    • Integer count(String dataspaceName, String cpsPath);
    • void updateDataNode(String dataspaceName, String anchorName, DataNode dataNode);
    • void setLeaf(String dataspaceName, String anchorName, String xPathId, String leafName, Object leafValue);
    • Void deleteDataNode(String dataspaceName, String anchorName, String xPathId);
    2DataNode Object
    • DataNode createDataNode(DataNode)
    • String getCpsPath()
    • DataNode getAttributes()
    • DataNode getAttribute(name)
    • Void setAttributes()
    • Void setAttribute(name)
    • Module getModule(moduleName)

    CpsAdmin SPI


    		Name


     Capabilities

    1
    CpsAdminService
    • String createDataspace(String dataspaceName);
    • String createAnchor(String dataspaceName, String anchorName);
    • List<String> getDataspaces();
    • Collection<Anchor> getAnchors(String dataspaceName);
    • Anchor getAnchor(String dataspaceName, String anchorName);
    • void deleteAnchor(String dataspaceName, String anchorName);
    • void associateAnchorToModuleSet(String dataspaceName, String moduleSetName, String anchorName);
    • boolean exists(String dataspaceName);
    2

    DataspacePersistenceService


    • Void createDataspace(dataspaceName)
    • Void getDataspace(dataspaceName)
    • Void getDataspaces()
    • boolean exists(dataspaceName)
    3AnchorPersistenceService
    • Void createAnchor(dataspaceName, anchorName)
    • Anchor getAnchors()
    • Anchor getAnchor(anchorName)
    • Void deleteAnchor(anchorName)
    • Void associateAnchor(anchorName, moduleSetName)
    • Void associateAnchor(anchorName, moduleRef)
    • Void addDataNode(anchorName, dataNode)
    4Dataspace (object)
    • Void createDataspace(dataspaceName)
    • String getName(Dataspace)
    5Anchor Object
    • Void createAnchor(anchorName)
    • String getName(Anchor)

    Module SPI


    		Name


     Capabilities

    1
    ModuleStoreService
    • Collection<String> getModules(String dataspaceName, String moduleSetName);
    • Collection<ModuleRef> getModuleRefs(String dataspaceName, String moduleSetName);
    • Void deleteModuleSet(String dataspaceName, String moduleSetName);
    2

    ModulePersistenceService


    • YangModule getModule(moduleRef)
    • Collection<YangModule> getModules(moduleSetName)
    3YangModule
    • ModuleRef getModuleRef(moduleRef)
    • String getModuleContent(moduleRef)
    4ModuleRef
    • String getNamespace(moduleRef)
    • String getRevision(moduleRef)
    5ModuleSet
    • String getName(moduleRef)
    • Collection<ModuleRef> getModuleRefs()


    Javadoc


    View file
    namejavadoc.zip
    height250