com.flowable.dataobject.engine.impl.runtime.datasource.db

Class DatabaseSchemaDataObjectDataSourceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<DataObjectEngineConfiguration>

com.flowable.dataobject.engine.impl.runtime.datasource.db.DatabaseSchemaDataObjectDataSourceImpl

All Implemented Interfaces:

DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>, DatabaseSchemaDataObjectDataSource

public class DatabaseSchemaDataObjectDataSourceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<DataObjectEngineConfiguration>
implements DatabaseSchemaDataObjectDataSource

Author:

Filip Hrisafov

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
DatabaseSchemaDataObjectDataSourceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and Description
DatabaseSchemaDataObjectInstance	create(DatabaseSchemaDataObjectInstanceBuilderImpl dataObjectInstanceBuilder)
DatabaseSchemaDataObjectInstanceBuilder	createDataObjectInstanceBuilder() Creates a new data object instance builder object used to create new data object instances and persist them.
DatabaseSchemaDataObjectInstanceQuery	createDataObjectInstanceQuery() Creates a new data object instance query object used to define a query returning data object instances.
DatabaseSchemaDataObjectInstanceQuery	createDataObjectInstanceQueryWithDefinitionId(String definitionId) Creates a new data object instance query object used to define a query returning data object instances.
DatabaseSchemaDataObjectInstanceQuery	createDataObjectInstanceQueryWithDefinitionKey(String definitionKey) Creates a new data object instance query object used to define a query returning data object instances.
DatabaseSchemaDataObjectModificationBuilder	createDataObjectModificationBuilder(String lookupId, String definitionId) Creates a new data object modification builder used to modify an existing data object with strong type support.
void	deleteDataObjectInstance(String lookupId, String definitionId) Deletes the specified data object given by its lookup id and specified by the data object definition and model.
DatabaseSchemaDataObjectInstanceEntity	findDataObjectByLookupIdAndDefinitionId(String lookupId, String definitionId) Lookup a single data object given by its lookup id and definition id.
DatabaseSchemaDataObjectInstance	findDataObjectByLookupIdAndDefinitionKey(String lookupId, String definitionKey) Lookup a single data object given by its lookup id and definition key.
String	getDescription() Returns the optional description for this data source.
String	getId() Returns the id of this source which must be unique within the system, so there must only be exactly one data source with that id.
String	getName() Returns the name of this data source which might be used as a label, but never for referencing it.
DatabaseSchemaDataObjectInstance	modify(DatabaseSchemaDataObjectModificationBuilderImpl databaseSchemaDataObjectModificationBuilder)

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseSchemaDataObjectDataSourceImpl

public DatabaseSchemaDataObjectDataSourceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Detail

getId

public String getId()

Description copied from interface: DataObjectDataSource

Returns the id of this source which must be unique within the system, so there must only be exactly one data source with that id.

Specified by:

getId in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Returns:

the id of this data source

getName

public String getName()

Description copied from interface: DataObjectDataSource

Returns the name of this data source which might be used as a label, but never for referencing it.

Specified by:

getName in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Returns:

the name of this data source

getDescription

public String getDescription()

Description copied from interface: DataObjectDataSource

Returns the optional description for this data source.

Specified by:

getDescription in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Returns:

the description of this data source

findDataObjectByLookupIdAndDefinitionId

public DatabaseSchemaDataObjectInstanceEntity findDataObjectByLookupIdAndDefinitionId(String lookupId,
                                                                                      String definitionId)

Description copied from interface: DataObjectDataSource

Lookup a single data object given by its lookup id and definition id.

Specified by:

findDataObjectByLookupIdAndDefinitionId in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Parameters:

lookupId - the lookup id of the data object to be returned

definitionId - the data object definition id to load a data object for

Returns:

the data object instance, if found, null otherwise

findDataObjectByLookupIdAndDefinitionKey

public DatabaseSchemaDataObjectInstance findDataObjectByLookupIdAndDefinitionKey(String lookupId,
                                                                                 String definitionKey)

Description copied from interface: DataObjectDataSource

Lookup a single data object given by its lookup id and definition key.

Specified by:

findDataObjectByLookupIdAndDefinitionKey in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Parameters:

lookupId - the lookup id of the data object to be returned

definitionKey - the data object definition key to load a data object for

Returns:

the data object instance, if found, null otherwise

createDataObjectInstanceQuery

public DatabaseSchemaDataObjectInstanceQuery createDataObjectInstanceQuery()

Description copied from interface: DataObjectDataSource

Creates a new data object instance query object used to define a query returning data object instances.

Specified by:

createDataObjectInstanceQuery in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Returns:

the data object instance query builder object

createDataObjectInstanceQueryWithDefinitionKey

public DatabaseSchemaDataObjectInstanceQuery createDataObjectInstanceQueryWithDefinitionKey(String definitionKey)

Description copied from interface: DataObjectDataSource

Creates a new data object instance query object used to define a query returning data object instances.

Specified by:

createDataObjectInstanceQueryWithDefinitionKey in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Parameters:

definitionKey - the data object definition key to query data objects for

Returns:

the data object instance query builder object

createDataObjectInstanceQueryWithDefinitionId

public DatabaseSchemaDataObjectInstanceQuery createDataObjectInstanceQueryWithDefinitionId(String definitionId)

Description copied from interface: DataObjectDataSource

Creates a new data object instance query object used to define a query returning data object instances.

Specified by:

createDataObjectInstanceQueryWithDefinitionId in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Parameters:

definitionId - the data object definition id to query data objects for

Returns:

the data object instance query builder object

createDataObjectInstanceBuilder

public DatabaseSchemaDataObjectInstanceBuilder createDataObjectInstanceBuilder()

Description copied from interface: DataObjectDataSource

Creates a new data object instance builder object used to create new data object instances and persist them.

Specified by:

createDataObjectInstanceBuilder in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Returns:

the data object instance builder object

createDataObjectModificationBuilder

public DatabaseSchemaDataObjectModificationBuilder createDataObjectModificationBuilder(String lookupId,
                                                                                       String definitionId)

Description copied from interface: DataObjectDataSource

Creates a new data object modification builder used to modify an existing data object with strong type support. If needed by the data source implementation, the builder might load and hold the current data object first to allow modified data to be applied directly, specially, if partial updates are not supported as the modification builder might only update partial data of the object.

Specified by:

createDataObjectModificationBuilder in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Parameters:

lookupId - the lookup id of the data object to be modified

definitionId - the data object definition id to create a new modification builder for

Returns:

the data object modification builder

deleteDataObjectInstance

public void deleteDataObjectInstance(String lookupId,
                                     String definitionId)

Description copied from interface: DataObjectDataSource

Deletes the specified data object given by its lookup id and specified by the data object definition and model.

Specified by:

deleteDataObjectInstance in interface DataObjectDataSource<DatabaseSchemaDataObjectInstance,DatabaseSchemaDataObjectInstanceQuery,DatabaseSchemaDataObjectInstanceBuilder,DatabaseSchemaDataObjectModificationBuilder>

Parameters:

lookupId - the lookup id of the data object to be deleted

definitionId - the data object definition id to delete an object instance for

create

public DatabaseSchemaDataObjectInstance create(DatabaseSchemaDataObjectInstanceBuilderImpl dataObjectInstanceBuilder)

modify

public DatabaseSchemaDataObjectInstance modify(DatabaseSchemaDataObjectModificationBuilderImpl databaseSchemaDataObjectModificationBuilder)