iot.jcypher.domain

Interface IGenericDomainAccess

All Known Implementing Classes:

DomainAccess.GenericDomainAccess, DomainAccessSync.GenericDomainAccessSync

public interface IGenericDomainAccess

Provides methods to access a domain graph based on a generic domain model.

Method Summary

Methods

Modifier and Type	Method and Description
ITransaction	beginTX() create a transaction
GDomainQuery	createQuery() create a new generic domain query
IDomainAccess	getDomainAccess() Answer a domain access object.
DOType	getDomainObjectType(String typeName) Answer a domain object type for the given typeName.
SyncInfo	getSyncInfo(DomainObject domainObject) For every domain object stored in the graph database a SyncInfo object can be retrieved.
List<SyncInfo>	getSyncInfos(List<DomainObject> domainObjects) For every domain object stored in the graph database a SyncInfo object can be retrieved.
DOTypeBuilderFactory	getTypeBuilderFactory() Answer a factory for retrieving type builders.
DomainObject	loadById(String domainObjectClassName, int resolutionDepth, long id) Load a generic domain object from the graph database.
List<DomainObject>	loadByIds(String domainObjectClassName, int resolutionDepth, long... ids) Load a list of generic domain objects from the graph database.
List<DomainObject>	loadByType(String domainObjectClassName, int resolutionDepth, int offset, int count) All objects of the type specified by domainObjectClassName or of any subtype will be loaded as generic domain objects from the domain graph and returned in a list.
List<Long>	numberOfInstancesOf(List<String> typeNames) answer the numbers of instances of the specified types (specified by type names) and of all of these type's subtypes stored in the domain graph
long	numberOfInstancesOf(String typeName) answer the number of instances of a certain type (specified by type name) and of all of that type's subtypes stored in the domain graph
IGenericDomainAccess	setLockingStrategy(Locking locking) Set the locking strategy (e.g.
List<JcError>	store(DomainObject domainObject) Store a domain object.
List<JcError>	store(List<DomainObject> domainObjects) Store a list of domain objects.

Method Detail

getSyncInfos

List<SyncInfo> getSyncInfos(List<DomainObject> domainObjects)

For every domain object stored in the graph database a SyncInfo object can be retrieved. A SyncInfo can be asked for the object's id (i.e. the id of the node in the graph to which the object was mapped). A SyncInfo can be asked for the object's resolution depth, which can be 'SHALLOW' or 'DEEP'.

Parameters:

domainObjects - a list of domain objects that have been stored in the domain graph.

Returns:

a list of SyncInfo objects, one for every object in domainObjects

getSyncInfo

SyncInfo getSyncInfo(DomainObject domainObject)

For every domain object stored in the graph database a SyncInfo object can be retrieved. A SyncInfo can be asked for the object's id (i.e. the id of the node in the graph to which the object was mapped). A SyncInfo can be asked for the object's resolution depth, which can be 'SHALLOW' or 'DEEP'.

Parameters:

domainObject - a domain object that has been stored in the domain graph.

Returns:

a SyncInfo object

store

List<JcError> store(DomainObject domainObject)

Store a domain object. The entire object graph rooted by the domain object is mapped to the graph database.

Parameters:

domainObject -

Returns:

a possibly emty list of errors.

store

List<JcError> store(List<DomainObject> domainObjects)

Store a list of domain objects. The entire object graphs rooted by the domain objects are mapped to the graph database.

Parameters:

domainObjects -

Returns:

a possibly emty list of errors.

loadByIds

List<DomainObject> loadByIds(String domainObjectClassName,
                           int resolutionDepth,
                           long... ids)

Load a list of generic domain objects from the graph database. By means of the second parameter you can specify the resolution depth. 0 would mean you only load simple attributes into the objects (i.e. attributes which have been stored to a node property; strings, numbers, booleans, or dates). Complex attributes are stored in separate nodes accessed via relations. So with the second parameter you can specify how deep exactly the graph should be navigated when loading objects. -1 means resolution as deep as possible (until leafs of the graph, i.e. objects which at most have simple attributes, are reached or until a cycle (loop) is detected).

Parameters:

domainObjectClassName -

resolutionDepth -

ids - a list of object ids (i.e. the ids of the nodes in the graph to which the objects were mapped).

Returns:

a list of domain objects

loadById

DomainObject loadById(String domainObjectClassName,
                    int resolutionDepth,
                    long id)

Load a generic domain object from the graph database. By means of the second parameter you can specify the resolution depth. 0 would mean you only load simple attributes into the object (i.e. attributes which have been stored to a node property; strings, numbers, booleans, or dates). Complex attributes are stored in separate nodes accessed via relations. So with the second parameter you can specify how deep exactly the graph should be navigated when loading the object. -1 means resolution as deep as possible (until leafs of the graph, i.e. objects which at most have simple attributes, are reached or until a cycle (loop) is detected).

Parameters:

domainObjectClassName -

resolutionDepth -

id - an object id (i.e. the id of the node in the graph to which the object was mapped).

Returns:

a domain object

loadByType

List<DomainObject> loadByType(String domainObjectClassName,
                            int resolutionDepth,
                            int offset,
                            int count)

All objects of the type specified by domainObjectClassName or of any subtype will be loaded as generic domain objects from the domain graph and returned in a list. You can even use 'java.lang.Object' in which case all domain objects in the graph will be returned. You also can specify the resolution depth. Additionally, you can specify an offset (parameter 3) and a count (parameter 4) of objects to be returned with respect to a list containing the total number of objects of the specified type. This feature provides the possibility to do pagination. Offset 0 and count -1 will return a list of all objeccts of the specified type. To really make use of the pagination feature you need to know the total number of objects of a certain type. The method 'numberOfInstancesOf(...)' provides this information

Parameters:

domainObjectClassName - specifies the type of objects that should be loaded.

resolutionDepth -

offset -

count -

Returns:

a list of domain objects.

numberOfInstancesOf

long numberOfInstancesOf(String typeName)

answer the number of instances of a certain type (specified by type name) and of all of that type's subtypes stored in the domain graph

Parameters:

typeName -

Returns:

the number of instances

numberOfInstancesOf

List<Long> numberOfInstancesOf(List<String> typeNames)

answer the numbers of instances of the specified types (specified by type names) and of all of these type's subtypes stored in the domain graph

Parameters:

types - a list of typeNames

Returns:

a list containing the instances counts

createQuery

GDomainQuery createQuery()

create a new generic domain query

Returns:

a GDomainQuery

beginTX

ITransaction beginTX()

create a transaction

Returns:

an instance of ITransaction

setLockingStrategy

IGenericDomainAccess setLockingStrategy(Locking locking)

Set the locking strategy (e.g. Locking.OPTIMISTIC, ...).

Parameters:

locking -

Returns:

the IGenericDomainAccess instance (self) to allow fluent method concatenation.

getTypeBuilderFactory

DOTypeBuilderFactory getTypeBuilderFactory()

Answer a factory for retrieving type builders. Type builders are the means to specify domain object types
for building a generic domain model.

Returns:

a DOTypeBuilderFactory

getDomainObjectType

DOType getDomainObjectType(String typeName)

Answer a domain object type for the given typeName.
Answer null, if no domain object type for the given typeName exists.
In that case you may need to create one using a type builder.

Parameters:

typeName -

Returns:

a DOType or null

getDomainAccess

IDomainAccess getDomainAccess()

Answer a domain access object.

Returns:

an IDomainAccess.