DomainAccessSync (net.iot-solutions.graphdb:jcypher 3.2.1 API)

java.lang.Object
- iot.jcypher.domain.internal.DomainAccessSync

All Implemented Interfaces:: IDomainAccess, IIntDomainAccess

public class DomainAccessSync
extends Object
implements IDomainAccess, IIntDomainAccess

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DomainAccessSync.GenericDomainAccessSync
- Nested classes/interfaces inherited from interface iot.jcypher.domain.IDomainAccess
  IDomainAccess.DomainLabelUse

Nested Classes
Modifier and Type	Class and Description
`class`	`DomainAccessSync.GenericDomainAccessSync`

Method Summary

Methods
Modifier and Type	Method and Description
`ITransaction`	`beginTX()` create a transaction
`DomainQuery`	`createQuery()` create a new domain query
`IGenericDomainAccess`	`getGenericDomainAccess()` Answer a domain access object which works with a generic domain model.
`DomainAccess.InternalDomainAccess`	`getInternalDomainAccess()`
`SyncInfo`	`getSyncInfo(Object domainObject)` For every domain object stored in the graph database a SyncInfo object can be retrieved.
`List<SyncInfo>`	`getSyncInfos(List<Object> domainObjects)` For every domain object stored in the graph database a SyncInfo object can be retrieved.
`<T> T`	`loadById(Class<T> domainObjectClass, int resolutionDepth, long id)` Load a domain object from the graph database.
`<T> List<T>`	`loadByIds(Class<T> domainObjectClass, int resolutionDepth, long... ids)` Load a list of domain objects from the graph database.
`<T> List<T>`	`loadByType(Class<T> domainObjectClass, int resolutionDepth, int offset, int count)` All objects of the specified type or any subtype of it will be loaded from the domain graph and returned in a list.
`long`	`numberOfInstancesOf(Class<?> type)` answer the number of instances of a certain type and of all of that type's subtypes stored in the domain graph
`List<Long>`	`numberOfInstancesOf(List<Class<?>> types)` answer the numbers of instances of the specified types and of all of these type's subtypes stored in the domain graph
`IDomainAccess`	`setLockingStrategy(Locking locking)` Set the locking strategy (e.g.
`List<JcError>`	`store(List<?> domainObjects)` Store a list of domain objects.
`List<JcError>`	`store(Object domainObject)` Store a domain object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getSyncInfos
```
public List<SyncInfo> getSyncInfos(List<Object> domainObjects)
```
    Description copied from interface: IDomainAccess
    
    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'.
    
    Specified by:
    
    getSyncInfos in interface IDomainAccess
    
    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
```
public SyncInfo getSyncInfo(Object domainObject)
```
    Description copied from interface: IDomainAccess
    
    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'.
    
    Specified by:
    
    getSyncInfo in interface IDomainAccess
    
    Parameters:
    domainObject - a domain object that has been stored in the domain graph.
    
    Returns:
    a SyncInfo object
  - loadByIds
```
public <T> List<T> loadByIds(Class<T> domainObjectClass,
                    int resolutionDepth,
                    long... ids)
```
    Description copied from interface: IDomainAccess
    
    Load a list of 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).
    
    Specified by:
    
    loadByIds in interface IDomainAccess
    
    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
```
public <T> T loadById(Class<T> domainObjectClass,
             int resolutionDepth,
             long id)
```
    Description copied from interface: IDomainAccess
    
    Load a 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).
    
    Specified by:
    
    loadById in interface IDomainAccess
    
    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
```
public <T> List<T> loadByType(Class<T> domainObjectClass,
                     int resolutionDepth,
                     int offset,
                     int count)
```
    Description copied from interface: IDomainAccess
    
    All objects of the specified type or any subtype of it will be loaded from the domain graph and returned in a list. You can even use 'Object.class' in which case all domain objects in the graph will be returned. Again you 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
    
    Specified by:
    
    loadByType in interface IDomainAccess
    
    Parameters:
    domainObjectClass - specifies the type of objects that should be loaded.
    
    Returns:
    a list of domain objects.
  - store
```
public List<JcError> store(List<?> domainObjects)
```
    Description copied from interface: IDomainAccess
    
    Store a list of domain objects. The entire object graphs rooted by the domain objects are mapped to the graph database.
    
    Specified by:
    
    store in interface IDomainAccess
    
    Returns:
    a possibly emty list of errors.
  - store
```
public List<JcError> store(Object domainObject)
```
    Description copied from interface: IDomainAccess
    
    Store a domain object. The entire object graph rooted by the domain object is mapped to the graph database.
    
    Specified by:
    
    store in interface IDomainAccess
    
    Returns:
    a possibly emty list of errors.
  - numberOfInstancesOf
```
public long numberOfInstancesOf(Class<?> type)
```
    Description copied from interface: IDomainAccess
    
    answer the number of instances of a certain type and of all of that type's subtypes stored in the domain graph
    
    Specified by:
    
    numberOfInstancesOf in interface IDomainAccess
    
    Returns:
    the number of instances
  - numberOfInstancesOf
```
public List<Long> numberOfInstancesOf(List<Class<?>> types)
```
    Description copied from interface: IDomainAccess
    
    answer the numbers of instances of the specified types and of all of these type's subtypes stored in the domain graph
    
    Specified by:
    
    numberOfInstancesOf in interface IDomainAccess
    
    Parameters:
    types - a list of types
    
    Returns:
    a list containing the instances counts
  - createQuery
```
public DomainQuery createQuery()
```
    Description copied from interface: IDomainAccess
    
    create a new domain query
    
    Specified by:
    
    createQuery in interface IDomainAccess
    
    Returns:
    a DomainQuery
  - beginTX
```
public ITransaction beginTX()
```
    Description copied from interface: IDomainAccess
    
    create a transaction
    
    Specified by:
    
    beginTX in interface IDomainAccess
    
    Returns:
    an instance of ITransaction
  - setLockingStrategy
```
public IDomainAccess setLockingStrategy(Locking locking)
```
    Description copied from interface: IDomainAccess
    
    Set the locking strategy (e.g. Locking.OPTIMISTIC, ...).
    
    Specified by:
    
    setLockingStrategy in interface IDomainAccess
    
    Returns:
    the IDomainAccess instance (self) to allow fluent method concatenation.
  - getGenericDomainAccess
```
public IGenericDomainAccess getGenericDomainAccess()
```
    Description copied from interface: IDomainAccess
    
    Answer a domain access object which works with a generic domain model.
    
    Specified by:
    
    getGenericDomainAccess in interface IDomainAccess
    
    Returns:
    an IGenericDomainAccess.
  - getInternalDomainAccess
```
public DomainAccess.InternalDomainAccess getInternalDomainAccess()
```
    Specified by:
    
    getInternalDomainAccess in interface IIntDomainAccess

Class DomainAccessSync

Nested Class Summary

Nested classes/interfaces inherited from interface iot.jcypher.domain.IDomainAccess

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSyncInfos

getSyncInfo

loadByIds

loadById

loadByType

store

store

numberOfInstancesOf

numberOfInstancesOf

createQuery

beginTX

setLockingStrategy

getGenericDomainAccess

getInternalDomainAccess