...
Jira | ||||||||
---|---|---|---|---|---|---|---|---|
|
Decisions
# | Description | Details | Decisions |
---|---|---|---|
1 | Assume flat attributes (no complex data types) but data could be stored as json object in SPI impl. for convenience/PoC | ||
2 | SPI Implementation NOT using Model (service) current ENM SPI does! |
Open Issues
# | Description | Details | Decisions |
---|---|---|---|
1 | Are we going to have XPath/query builder? |
| |
2 | 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 of the API 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)) | ||
3 | SPI should be type safe (the SPI impl. has no access to models)
| We can do validation but still store as a string (JSON object). |
ENM SPI Study
Details about the ENM SPI can be found here: https://wiki.onap.org/pages/resumedraft.action?draftId=92998891&draftShareId=2f0190f4-bc97-47b7-bd82-6561f3606575&
...
Proposed Future Implementation of CPS SPI
Data SPI
Name | Definition | Capabilities | |
---|---|---|---|
1 |
Module SPI
SimpleDataObject | Provides the basic information needed to access an object. |
| |
2 | DataPersistenceLayer |
Gets the data bucket name to which this persistence object belongs.
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.
Passes the attributes supplied by the user for a new persistence object so that they may be verified as required.
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:
Gets the values for the attributes which have been specifically set on this object. This includes attributes which:
Note that an attribute may have been specifically set to null so the values returned in the map may contain nulls.
Determines if the supplied attribute has been specifically set (includes attributes which were set to null).
Gets all of the attribute names available in this persistence object.
Unsets the values of the supplied attributes. |
Module SPI
Name | Definition | Capabilities | |
---|---|---|---|
1 | ModulePersistenceLayer |
Remove all associations of this persistence object.
Retrieves the namespace of the type of object the type query is to target. | |
2 | BasicModuleObject |
|
Definition
Capabilities
Module Interface
Provides CRUD operations on a module set.
Query SPI
Name | Definition | Capabilities | |
---|---|---|---|
1 | Interface QueryService | Service responsible for dealing with query related features of CPS. |
Executes the query and presents the result as an iterator of objects queried for.
Executes the query and presents the result as a list. Returns a list of the type of which is based on the Projection used.
Executes the query and presents the result as a list. Will return a list of type Object array.
Executes the query and presents the result as a count of how many instances are matched against the query.
Deletes all matching objects and where appropriate deletes any children.
Executes the query ands gets the result as an iterable of 'full' objects queried.
Project the results from points in the query path. Projections allow the user project a single data element from the objects which were found along a query path - these elements can be modelled (i.e. persistence object attributes) or non-modelled (i.e. object fields).
Retrieves the type of object that the type query is to target. |
2 | Interface QueryPathService | Service responsible for dealing with path query related features |
executes the path query against the db. returns a list of type Object.
Executes the query ands gets the result as an iterable of 'full' objects queried. |
4 | Interface CpsRestriction |
Gets the restriction used in the query criteria, including any internal restrictions added in addition to those set by the user.
Retrieves the name of the attribute that the restriction is. |