Table of Contents |
---|
Study the existing SPI used in ENM to migrate from Versant to ENM implementation.
...
Name | Definition | Capabilities | |
---|---|---|---|
1 | Interface QueryService Interface | Service responsible for dealing with query related features of Data Persistence Service. |
Executes the query and presents the result as an iterator of objects queried for. Will always return the full object from the database.
Executes the query and presents the result as a list. Returns a list, the type of which is based on the Projection used.
Executes the query and presents the result as a list. Will return a projection with an List on which the type of data will be an 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 related managed object. |
2 | Interface QueryPathService | Service responsible for dealing with path query related features of Data Persistence Service. |
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 single data elements 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). |
Query Criterion
cps-persistence-spi-spi-docs\docs\dps-core-spi\com\ericsson\oss\itpf\datalayer\dps\query\criterion\spi
Name | Definition | Capabilities | |
---|---|---|---|
1 | Interface SortingOrder | Defines a sorting order which can be applied to a query to order its result set. |
Retrieves the sorting element used in this sorting order.
Retrieves the sorting direction used in this sorting order.
Retrieves the sorting type used in this sorting order. |
2 | Interface DpsTypeQuery | Specifies common functionality used by type queries. |
Get the namespace of the type of object the type query is to target.
Get the type of object that the type query is to target. |
3 | Interface DpsQuery | Specifies methods that are used internally by DPS but are not to be exposed externally to clients. |
Gets the sorting orders used in this query criteria.
Gets the category of query that this query criteria represents.
Gets the restriction used in these query criteria, including any DPS internal restrictions added in addition to those set by the user.
Indicates if conversion is needed for the returned results.
Are the query results to be ordered in a depth first manner? |
4 | Interface DpsContainmentQuery | Contains common functionality used by containment queries. |
Retrieve the FDN of the base MO of this query. The base MO is the managed object under which we will look for MOs matching the other criteria of this query. |
5 | Interface DpsObjectQuery | Specifies methods that are used internally by DPS but are not to be exposed externally to clients. |
Is the target type hierarchical, i.e. is it able to form containment relationships. |
6 | Interface DpsTypeContainmentQuery | Aggregates common functionality to type queries and containment queries. | Inherits methods from
|
Query Restriction
cps-persistence-spi-spi-docs\docs\dps-core-spi\com\ericsson\oss\itpf\datalayer\dps\query\restriction\spi
Name | Definition | Capabilities | |
---|---|---|---|
1 | Class AttributeInModelRestriction | Restriction to filter instances of specific versions (model version) only, where the given attribute name is defined. |
Method that is inverting the given restriction Returns - newly created restriction that is a negation of the base restriction
Indicates the type of restriction type that this restriction represents.
Is the restriction negated? |
2 | Class AttributePathRestriction | A restriction to compare modeled attributes against path values. |
|
3 | Class AttributeRestriction | Simple restriction involving attribute values. |
|
4 | Class BetweenRestriction | Class to resolve between and not between restrictions. |
|
5 | Class ContainmentRestriction | Creates a containment restriction applicable for change logs (e.g. get change logs for all managed objects under supplied FDN of MIB root) |
|
6 | Class DescendantsRestriction | Class to resolve descendants and not descendants restrictions. |
|
7 | Interface DpsRestriction | DPS Internal contract for |
|
8 | Class HasMemberRestriction | Creates a HasMember restriction applicable for group entities (e.g. get groups that have a persistence object as member) |
|
9 | Class InRestriction | Class that creates an IN restriction type, restricting an attribute to a list of values. |
|
10 | Class InternalRestriction | Creates an internal restriction applicable for group entities. |
|
11 | Class ListMemberRestriction | A restriction which verifies if a list attribute has members matching specific restrictions. |
|
12 | Class ListRestriction | Common functionality of a List restriction. |
|
13 | Class LogicalRestriction | Implement logical restriction (AND/OR) and the negation of this logical restriction. |
|
14 | Class NullValueRestriction | Implementation of the null value restriction and not null value restriction. |
|
15 | Class ObjectFieldBetweenRestriction | Class to resolve between and not between restrictions for ObjectFields. |
Gets the object field that the restriction applies to.
|
16 | Class ObjectFieldInRestriction | Class that creates an IN Restriction type, restricting a Object Field to a list of values. |
|
17 | Class ObjectFieldPartialMatchRestriction | Implementation of the partial match restriction and not match restriction. |
|
18 | Class ObjectFieldPathRestriction | A restriction to compare object fields against path values. |
|
19 | Interface ObjectFieldRestriction | A restriction that applies to an object field as opposed to a modelled field. |
|
20 | Class ObjectFieldRetriever | Some object field restrictions serialized as part of a saved query by earlier versions of the relevant restriction class may be missing the object field when deserialized. This utility class allows the missing object field to be determined from the 'attributeName' that will have been stored instead. TODO This workaround can be removed once we have given teams time to recreate any object field saved queries they may have. |
ObjectField.getFieldName() method. |
21 | Class ObjectFieldSimpleRestriction | Creates a simple restriction (e.g. compare one field to one value) for object fields. |
|
22 | Class PartialMatchRestriction | Implementation of the partial match restriction and not match restriction. |
|
23 | Class PathRestriction | Base class for path restrictions. |
|
24 | Class RedundantRestriction | Abstract class to add property to check for redundant restriction in query. |
Gets the flag value of a query, which is using only one, AND-ed redundant restriction or not.
Sets a flag of a query, which is using only one, AND-ed redundant restriction or not. |
25 | Class SimpleRestriction | Creates a simple restriction (e.g. compare one field to one value). |
|
Object
cps-persistence-spi-spi-docs\docs\dps-core-spi\com\ericsson\oss\itpf\datalayer\dps\spi
Name | Definition | Capabilities | |
---|---|---|---|
1 | Interface DataBucketManager | This interface is used to manage the data buckets from the persistence layer. |
Get the stored data bucket with the given name.
Create a new data bucket.
Delete the data bucket from the persistence store. This method will silently ignore buckets which do not exist. Also, this method will take no responsibility for handling the objects in the bucket. It is up to the higher levels in DPS to manage those.
Method to get the names of all data buckets in the system. |
2 | Interface ServiceManager | Defines the capabilities of a class that can be used to register and to retrieve a reference to a DPS persistence service provider. |
Registers a new service provider.
Retrieve the registered service provider.
De-register the service provider. |
3 | Interface ServiceProvider | Defines the capabilities of a class that can be used to retrieve a reference to services offered by DPS persistence layer. |
Checks if service provider is Neo4j.
Gets the object manager.
Gets the object locator.
Gets the data bucket manager.
Gets the group manager.
Gets the change log manager.
Gets the query service.
Gets the query path service.
Gets the database storage manager.
Gets the database storage space reader.
Get the migration controller.
Get upgrade utilities.
Get last known bookmarks.
Get object that can calculate the number of instances of each PO type. |
SPI
cps-persistence-spi-spi-docs\docs\dps-core-spi\com\ericsson\oss\itpf\datalayer\dps\spi
Name | Definition | Capabilities | |
---|---|---|---|
1 | Interface DataBucketManager | This interface is used to manage the data buckets from the persistence layer. |
|
2 | Interface ServiceManager | Defines the capabilities of a class that can be used to register and to retrieve a reference to a DPS persistence service provider. |
|
3 | Interface ServiceProvider | Defines the capabilities of a class that can be used to retrieve a reference to services offered by DPS persistence layer. |
Checks if service provider is Neo4j.
Gets the object manager.
Gets the object locator.
Gets the data bucket manager.
Gets the group manager.
Gets the change log manager.
Gets the query service.
Gets the query path service.
Gets the database storage manager.
Gets the database storage space reader.
Get the migration controller.
Get upgrade utilities.
Get last known bookmarks.
|