Page History

ENM SPI Study

Proposed Future Implementation of CPS SPI

Space shortcuts

Page tree

Versions Compared

Key

ENM SPI Study

Proposed Future Implementation of CPS SPI

DataStore SPI

CpsAdmin SPI

Module SPI

Query SPI

Old Version 10

New Version 11

DataStore SPI

CpsAdmin SPI

Module SPI

Query SPI

...

Warning

title	Decoupling

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

	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!
3	Are 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 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))
5	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 have the following options Default is no attributes All Attributes Specify attributes - output specification (filter)
6	Should we use the name node or fragment?		DataNode /Node
7	Do we want to split the interface?	Maybe we could just have a 3 Alternatives all in one interface Limited number of interfaces e.g Data Objects/ Data Persistence/Query Very fine grained (see below)	peristenceStore.addChild(parentDataObject, childDataObject) Change Data SPI to DataStore - methods to add data. 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

Details about the ENM SPI can be found here: Spike

...

...

Name

Definition

Capabilities

1

SimpleDataObjectDataStoreObject

Provides 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

2

DataPersistenceServicePersistenceStore

Adding 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:

it verifies all mandatory attributes have been supplied
it initializes all non-supplied attributes to their default value where relevant
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:

were supplied at creation of the object or
had default values applied during creation or
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.

createDataspacegetByCpsPath
getDataspacescreateDataNode
getDataspaceassociateDataNodeToAnchor
deleteDataspace

3

FragmentObject

4

DataspaceObject

Create a simple CPS Dataspace Object

findByName
getByName
existsByName

...

associateAnchorToDataspace

Name

Definition

Capabilities

1

DataspacePersistenceService

createDataspace
GetDataspace
(GetDataspaces)

...

NameDefinition Capabilities1FragmentPersistenceServicegetByCpsPathcreateNodeassociateNodeToAnchorassociateAnchorToDataspace

Name

Definition

Capabilities

1

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

2

BasicModuleObject

Create a simple CPS Module Object

getModule
getNamespace
getType
getName
getVersion
equals
hashCode

Name

Definition

Capabilities

1

QueryService

Service responsible for dealing with query related features of CPS.

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

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

negate
getAttributeName
getAttributeValue
getSimpleExpressionOperator
toString

6

PartialMatchRestriction

Implementation of the partial match restriction and not match restriction.

negate
getRestrictionType
getMatchConditionType
getAttributeName
isNegated
getStringToMatch
toString

7

LogicalRestriction

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

negate

getRestrictionType

getRestrictionList

getLogicalOperator

isNegated

toString

findByName

existsByName

AnchorPersistenceService

createAnchor

getAnchors

deleteAnchor