org.bonitasoft.engine.data.instance.api.impl

Class DataInstanceServiceImpl

java.lang.Object

org.bonitasoft.engine.data.instance.api.impl.DataInstanceServiceImpl

All Implemented Interfaces:

DataInstanceService

public class DataInstanceServiceImpl
extends Object
implements DataInstanceService

General mechanism for lookup is to look in specific flow node to search a data instance. When referring to "local" data instance, it means the lookup is performed only on the specific element, and not on inherited data for parent containers.

Author:

Zhao Na, Elias Ricken de Medeiros, Feng Hui, Hongwen Zang, Matthieu Chaffotte, Baptiste Mesta: include data instance data source directly here

Field Summary

Fields

Modifier and Type	Field and Description
protected ArchiveService	archiveService
protected TechnicalLoggerService	logger
protected org.bonitasoft.engine.persistence.ReadPersistenceService	persistenceService
protected Recorder	recorder

Constructor Summary

Constructors

Constructor and Description
DataInstanceServiceImpl(Recorder recorder, org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService, ArchiveService archiveService, TechnicalLoggerService logger)

Method Summary

Modifier and Type	Method and Description
void	createDataInstance(SDataInstance dataInstance) Create dataInstance in DB for given dataInstance
void	deleteDataInstance(SDataInstance dataInstance) Delete the specific dataInstance
void	deleteLocalArchivedDataInstances(long containerId, String containerType) Delete all local archived data instances for a specified container
void	deleteLocalDataInstances(long containerId, String dataInstanceContainerType, boolean dataPresent) Delete all local active data instances for a specified container
SDataInstance	getDataInstance(long dataInstanceId) Get dataInstance by its id
SDataInstance	getDataInstance(String dataName, long containerId, String containerType, ParentContainerResolver parentContainerResolver) Get dataInstance visible in the specific container
List<SDataInstance>	getDataInstances(List<String> dataNames, long containerId, String containerType, ParentContainerResolver parentContainerResolver) Get dataInstances visible in the specific container for given names
List<SDataInstance>	getDataInstances(long containerId, String containerType, ParentContainerResolver parentContainerResolver, int fromIndex, int numberOfResults) Get all dataInstances visible in the specific container
List<SADataInstance>	getLastLocalSADataInstances(long containerId, String containerType, int startIndex, int maxResults) Gets the last archived SADataInstance objects of the container.
SADataInstance	getLastSADataInstance(String dataName, long containerId, String containerType, ParentContainerResolver parentContainerResolver) Gets the last archived SADataInstance object for the named data in the container.
SDataInstance	getLocalDataInstance(String dataName, long containerId, String containerType) Get the local dataInstance by name in a certain container, the dataInstance is existed in this container
List<SDataInstance>	getLocalDataInstances(long containerId, String containerType, int fromIndex, int numberOfResults) Get a list of local dataInstances for the specific container, those dataInstances must belong to the specified container.
List<SADataInstance>	getLocalSADataInstances(long containerId, String containerType, int fromIndex, int numberOfResults) Get the local SADataInstances for this element
long	getNumberOfDataInstances(long containerId, String containerType, ParentContainerResolver parentContainerResolver) Get number of dataInstance for specified container
SADataInstance	getSADataInstance(long sourceObjectId, long time) Get SADataInstance object for specific dataInstance at the specific time
SADataInstance	getSADataInstance(long containerId, String containerType, ParentContainerResolver parentContainerResolver, String dataName, long time) Get SADataInstance object archived in the specific time for name specified dataInstance in a container
List<SADataInstance>	getSADataInstances(long containerId, String containerType, ParentContainerResolver parentContainerResolver, List<String> dataNames, long time) Get all SADataInstance objects archived after specific time for specific dataInstance in a container
void	updateDataInstance(SDataInstance dataInstance, EntityUpdateDescriptor descriptor) Update the specific dataInstance according to the given descriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

recorder

protected final Recorder recorder

persistenceService

protected final org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService

archiveService

protected final ArchiveService archiveService

logger

protected final TechnicalLoggerService logger

Constructor Detail

DataInstanceServiceImpl

public DataInstanceServiceImpl(Recorder recorder,
                               org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService,
                               ArchiveService archiveService,
                               TechnicalLoggerService logger)

Method Detail

getDataInstance

public SDataInstance getDataInstance(String dataName,
                                     long containerId,
                                     String containerType,
                                     ParentContainerResolver parentContainerResolver)
                              throws SDataInstanceException

Description copied from interface: DataInstanceService

Get dataInstance visible in the specific container

Specified by:

getDataInstance in interface DataInstanceService

Parameters:

dataName - Name of data instance

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

Returns:

a SDataInstance object

Throws:

SDataInstanceException

getDataInstances

public List<SDataInstance> getDataInstances(long containerId,
                                            String containerType,
                                            ParentContainerResolver parentContainerResolver,
                                            int fromIndex,
                                            int numberOfResults)
                                     throws SDataInstanceException

Description copied from interface: DataInstanceService

Get all dataInstances visible in the specific container

Specified by:

getDataInstances in interface DataInstanceService

Parameters:

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

Returns:

Throws:

SDataInstanceException

getLocalDataInstance

public SDataInstance getLocalDataInstance(String dataName,
                                          long containerId,
                                          String containerType)
                                   throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get the local dataInstance by name in a certain container, the dataInstance is existed in this container

Specified by:

getLocalDataInstance in interface DataInstanceService

Parameters:

dataName - Name of dataInstance

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

Returns:

an SDataInstance object

Throws:

SDataInstanceReadException

getLocalDataInstances

public List<SDataInstance> getLocalDataInstances(long containerId,
                                                 String containerType,
                                                 int fromIndex,
                                                 int numberOfResults)
                                          throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get a list of local dataInstances for the specific container, those dataInstances must belong to the specified container. This method is paginated.

Specified by:

getLocalDataInstances in interface DataInstanceService

Parameters:

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

Returns:

a list of SDataInstance objects

Throws:

SDataInstanceReadException

getSADataInstance

public SADataInstance getSADataInstance(long containerId,
                                        String containerType,
                                        ParentContainerResolver parentContainerResolver,
                                        String dataName,
                                        long time)
                                 throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get SADataInstance object archived in the specific time for name specified dataInstance in a container

Specified by:

getSADataInstance in interface DataInstanceService

Parameters:

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

dataName - Name of data instance

time - The archive time

Returns:

an SADataInstance object

Throws:

SDataInstanceReadException

getSADataInstance

public SADataInstance getSADataInstance(long sourceObjectId,
                                        long time)
                                 throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get SADataInstance object for specific dataInstance at the specific time

Specified by:

getSADataInstance in interface DataInstanceService

Parameters:

sourceObjectId - Identifier of data instance which has been archived

time - The archive time

Returns:

an SADataInstance object

Throws:

SDataInstanceReadException

getLastSADataInstance

public SADataInstance getLastSADataInstance(String dataName,
                                            long containerId,
                                            String containerType,
                                            ParentContainerResolver parentContainerResolver)
                                     throws SDataInstanceException

Description copied from interface: DataInstanceService

Gets the last archived SADataInstance object for the named data in the container.

Specified by:

getLastSADataInstance in interface DataInstanceService

Parameters:

dataName - the name of the data

containerId - the identifier of the container

containerType - the type of the container

Returns:

the last archived SADataInstance

Throws:

SDataInstanceException

getSADataInstances

public List<SADataInstance> getSADataInstances(long containerId,
                                               String containerType,
                                               ParentContainerResolver parentContainerResolver,
                                               List<String> dataNames,
                                               long time)
                                        throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get all SADataInstance objects archived after specific time for specific dataInstance in a container

Specified by:

getSADataInstances in interface DataInstanceService

Parameters:

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

dataNames - Name of data

time - The archive time

Returns:

a list of SADataInstance objects

Throws:

SDataInstanceReadException

getLastLocalSADataInstances

public List<SADataInstance> getLastLocalSADataInstances(long containerId,
                                                        String containerType,
                                                        int startIndex,
                                                        int maxResults)
                                                 throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Gets the last archived SADataInstance objects of the container.

Specified by:

getLastLocalSADataInstances in interface DataInstanceService

Parameters:

containerId - the identifier of the container

containerType - the type of the container

Returns:

the last archived SADataInstance

Throws:

SDataInstanceReadException

getNumberOfDataInstances

public long getNumberOfDataInstances(long containerId,
                                     String containerType,
                                     ParentContainerResolver parentContainerResolver)
                              throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get number of dataInstance for specified container

Specified by:

getNumberOfDataInstances in interface DataInstanceService

Parameters:

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

Returns:

the number of dataInstances

Throws:

SDataInstanceReadException

getDataInstances

public List<SDataInstance> getDataInstances(List<String> dataNames,
                                            long containerId,
                                            String containerType,
                                            ParentContainerResolver parentContainerResolver)
                                     throws SDataInstanceException

Description copied from interface: DataInstanceService

Get dataInstances visible in the specific container for given names

Specified by:

getDataInstances in interface DataInstanceService

Parameters:

dataNames - A list of names of data instances

containerId - Identifier of container

containerType - Type of container, e.g process instance, activity instance and so on.

Returns:

a list of SDataInstance objects

Throws:

SDataInstanceException

getLocalSADataInstances

public List<SADataInstance> getLocalSADataInstances(long containerId,
                                                    String containerType,
                                                    int fromIndex,
                                                    int numberOfResults)
                                             throws SDataInstanceReadException

Description copied from interface: DataInstanceService

Get the local SADataInstances for this element

Specified by:

getLocalSADataInstances in interface DataInstanceService

Returns:

Throws:

SDataInstanceReadException

deleteLocalArchivedDataInstances

public void deleteLocalArchivedDataInstances(long containerId,
                                             String containerType)
                                      throws SDataInstanceException

Description copied from interface: DataInstanceService

Delete all local archived data instances for a specified container

Specified by:

deleteLocalArchivedDataInstances in interface DataInstanceService

Throws:

SDataInstanceException

deleteLocalDataInstances

public void deleteLocalDataInstances(long containerId,
                                     String dataInstanceContainerType,
                                     boolean dataPresent)
                              throws SDataInstanceException

Description copied from interface: DataInstanceService

Delete all local active data instances for a specified container

Specified by:

deleteLocalDataInstances in interface DataInstanceService

Throws:

SDataInstanceException

createDataInstance

public void createDataInstance(SDataInstance dataInstance)
                        throws SDataInstanceException

Description copied from interface: DataInstanceService

Create dataInstance in DB for given dataInstance

Specified by:

createDataInstance in interface DataInstanceService

Parameters:

dataInstance - SDataInstance object

Throws:

SDataInstanceException

updateDataInstance

public void updateDataInstance(SDataInstance dataInstance,
                               EntityUpdateDescriptor descriptor)
                        throws SDataInstanceException

Description copied from interface: DataInstanceService

Update the specific dataInstance according to the given descriptor

Specified by:

updateDataInstance in interface DataInstanceService

Parameters:

dataInstance - SDataInstance object will be updated

descriptor - Update description

Throws:

SDataInstanceException

deleteDataInstance

public void deleteDataInstance(SDataInstance dataInstance)
                        throws SDataInstanceException

Description copied from interface: DataInstanceService

Delete the specific dataInstance

Specified by:

deleteDataInstance in interface DataInstanceService

Parameters:

dataInstance - SDataInstance object will be deleted

Throws:

SDataInstanceException

getDataInstance

public SDataInstance getDataInstance(long dataInstanceId)
                              throws SDataInstanceException

Description copied from interface: DataInstanceService

Get dataInstance by its id

Specified by:

getDataInstance in interface DataInstanceService

Parameters:

dataInstanceId - Identifier of dataInstance

Returns:

a SDataInstance object

Throws:

SDataInstanceException