com.broadleafcommerce.data.tracking.core.service

Class BaseMappableCrudEntityService<P>

java.lang.Object

com.broadleafcommerce.data.tracking.core.service.BaseMappableCrudEntityService<P>

Type Parameters:

P - The business domain type

All Implemented Interfaces:

MappableCrudEntityService<P>

Direct Known Subclasses:

BaseRsqlMappableCrudEntityService

public class BaseMappableCrudEntityService<P>
extends Object
implements MappableCrudEntityService<P>

Real-world service implementations of MappableCrudEntityService can extend from this class as a convenience to inherit CRUD behavior for a particular business domain type. By default, this class in turn defers to MappableCrudEntityHelper in order to allow easier refactoring of core functionality.

If a service implementation spans several repository types, then it is recommended to inject the MappableCrudEntityHelper rather than extend this class.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor and Description
BaseMappableCrudEntityService(R repository, MappableCrudEntityHelper helper)

Method Summary

Modifier and Type	Method and Description
protected P	convertFromPersistentDomain(Object domain)
<D,R extends org.springframework.data.repository.CrudRepository<D,String> & com.broadleafcommerce.common.extension.DomainTypeAware> P	create(P businessInstance) Create an instance of an entity based on a business instance containing relevant property values.
<D,R extends org.springframework.data.repository.CrudRepository<D,String> & com.broadleafcommerce.common.extension.DomainTypeAware> List<P>	createAll(List<P> businessInstances) Create multiple instances of an entity at once based on the business instances containing relevant property values.
<D,R extends org.springframework.data.repository.CrudRepository<D,String> & com.broadleafcommerce.common.extension.DomainTypeAware> BulkPersistenceResponse<P>	createAllAllowingPartialSuccess(List<P> businessInstances) Creates multiple instances of an entity at once based on the business instances containing relevant property values.
void	delete(String id) Perform a delete operation on the entity identified by the id.
protected MappableCrudEntityHelper	getHelper()
protected org.springframework.data.repository.PagingAndSortingRepository<?,String>	getRepository()
List<P>	readAll() Read a list of instances in the form of the business instance.
org.springframework.data.domain.Page<P>	readAll(org.springframework.data.domain.Pageable pageable) Read a page of entity instances in the form of business instances.
List<P>	readAll(org.springframework.data.domain.Sort sort) Read a list of instances in the form of the business instance.
List<P>	readAllByIds(Iterable<String> ids) Reads all entity instances matching the provided ids.
P	readById(String id) Read a single instance of an entity in the form of a business domain.
P	replace(String id, P businessInstance) Replace a single instance of an entity based on a business instance containing relavant property values.
List<P>	replaceAll(List<Update<P>> replacements) Replace multiple instances of an entity at once based on the business instance containing relevant property values.
BulkPersistenceResponse<P>	replaceAllAllowingPartialSuccess(List<Update<P>> replacements) Replace multiple instances of an entity at once based on the business instances containing relevant property values.
P	update(String id, P businessInstance) Update a single instance of an entity based on a business instance containing relevant property values.
List<P>	updateAll(List<Update<P>> updates) A bulk operation that updates all of the items managed by the backing repository in the form of the business entity containing property values.
BulkPersistenceResponse<P>	updateAllAllowingPartialSuccess(List<Update<P>> updates) Updates all of the items managed by the backing repository in the form of the business instances containing property values.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseMappableCrudEntityService

public BaseMappableCrudEntityService(R repository,
                                     MappableCrudEntityHelper helper)

Method Detail

readById

public P readById(@NonNull
                  String id)

Description copied from interface: MappableCrudEntityService

Read a single instance of an entity in the form of a business domain.

Specified by:

readById in interface MappableCrudEntityService<P>

Parameters:

id - The id for the entity.

Returns:

The entity instance in the form of a business instance

readAllByIds

@NonNull
public List<P> readAllByIds(@NonNull
                                     Iterable<String> ids)

Description copied from interface: MappableCrudEntityService

Reads all entity instances matching the provided ids.

Specified by:

readAllByIds in interface MappableCrudEntityService<P>

Parameters:

ids - Iterable of ids to read

Returns:

List of matching instances

readAll

public List<P> readAll()

Description copied from interface: MappableCrudEntityService

Read a list of instances in the form of the business instance.

Specified by:

readAll in interface MappableCrudEntityService<P>

Returns:

The list of data in the form of business instances

readAll

public org.springframework.data.domain.Page<P> readAll(@NonNull
                                                       org.springframework.data.domain.Pageable pageable)

Description copied from interface: MappableCrudEntityService

Read a page of entity instances in the form of business instances.

Specified by:

readAll in interface MappableCrudEntityService<P>

Parameters:

pageable - information about which page of results to return. May be Pageable.unpaged(), may not be null.

Returns:

the requested page of entity instances in the form of business instances

readAll

public List<P> readAll(@NonNull
                       org.springframework.data.domain.Sort sort)

Description copied from interface: MappableCrudEntityService

Read a list of instances in the form of the business instance. Also apply the given sort.

Specified by:

readAll in interface MappableCrudEntityService<P>

Parameters:

sort - The sort to be performed on the results

Returns:

The list of sorted data in the form of business instances

update

public P update(@NonNull
                String id,
                @NonNull
                P businessInstance)

Description copied from interface: MappableCrudEntityService

Update a single instance of an entity based on a business instance containing relevant property values.

Specified by:

update in interface MappableCrudEntityService<P>

Parameters:

id - The id for the entity.

businessInstance - The payload type that domain class should be converted to. In general, the payload is what the rest API responds with.

Returns:

The updated entity instance in the form of a payload instance, or EntityMissingException if not available.

See Also:

MappableCrudEntityService.updateAll(List), MappableCrudEntityService.updateAllAllowingPartialSuccess(List)

updateAll

public List<P> updateAll(List<Update<P>> updates)

Description copied from interface: MappableCrudEntityService

A bulk operation that updates all of the items managed by the backing repository in the form of the business entity containing property values.

All items contained within updates must exist in the backing repository and pass validation, else the entire batch will fail

For an alternative that allows partial success, see MappableCrudEntityService.updateAllAllowingPartialSuccess(List).

Specified by:

updateAll in interface MappableCrudEntityService<P>

Parameters:

updates - each update to the repository domain

Returns:

all of the updated entity instance in the form of a payload instance, or EntityMissingException if not available.

See Also:

MappableCrudEntityService.update(String, Object), MappableCrudEntityService.updateAllAllowingPartialSuccess(List)

updateAllAllowingPartialSuccess

public BulkPersistenceResponse<P> updateAllAllowingPartialSuccess(List<Update<P>> updates)

Description copied from interface: MappableCrudEntityService

Updates all of the items managed by the backing repository in the form of the business instances containing property values.

Each item contained within updates must exist in the backing repository and pass validation, or it will be added to the failed list in the response and not persisted. All successfully found and validated items will be persisted.

For an alternative that does not allow partial success, see MappableCrudEntityService.updateAll(List).

Specified by:

updateAllAllowingPartialSuccess in interface MappableCrudEntityService<P>

Parameters:

updates - each update to the repository domain

Returns:

a response containing a list of any entities which failed, and a list of the successfully updated entity instances in the form of a payload instance

See Also:

MappableCrudEntityService.updateAll(List)

replace

public P replace(@NonNull
                 String id,
                 @NonNull
                 P businessInstance)

Description copied from interface: MappableCrudEntityService

Replace a single instance of an entity based on a business instance containing relavant property values.

Specified by:

replace in interface MappableCrudEntityService<P>

Parameters:

id - The id for the entity.

businessInstance - The payload type that domain class should be converted to. In general, the payload is what the rest API responds with.

Returns:

The replaced entity instance in the form of a payload instance, or EntityMissingException if not available.

See Also:

MappableCrudEntityService.replaceAll(List), MappableCrudEntityService.replaceAllAllowingPartialSuccess(List)

replaceAll

public List<P> replaceAll(List<Update<P>> replacements)

Description copied from interface: MappableCrudEntityService

Replace multiple instances of an entity at once based on the business instance containing relevant property values.

All items contained within replacements must exist in the backing repository and pass validation, else the entire batch will fail

See MappableCrudEntityService.replaceAllAllowingPartialSuccess(List) for an alternative that allows partial success.

Specified by:

replaceAll in interface MappableCrudEntityService<P>

Parameters:

replacements - all replacements to the repository domain

Returns:

all of the replaced entity instances in the form of a payload instance, or EntityMissingException if any of the items were not found

See Also:

MappableCrudEntityService.replaceAllAllowingPartialSuccess(List)

replaceAllAllowingPartialSuccess

public BulkPersistenceResponse<P> replaceAllAllowingPartialSuccess(List<Update<P>> replacements)

Description copied from interface: MappableCrudEntityService

Replace multiple instances of an entity at once based on the business instances containing relevant property values.

Each item contained within replacements must exist in the backing repository and pass validation, or it will be added to the failed list in the response and not persisted. All successfully found and validated items will be persisted.

See MappableCrudEntityService.replaceAll(List) for an alternative that does not allow partial success.

Specified by:

replaceAllAllowingPartialSuccess in interface MappableCrudEntityService<P>

Parameters:

replacements - all replacements to the repository domain

Returns:

a response containing a list of any entities which failed, and a list of the successfully replaced entity instances in the form of a payload instance

See Also:

MappableCrudEntityService.replaceAll(List)

create

public <D,R extends org.springframework.data.repository.CrudRepository<D,String> & com.broadleafcommerce.common.extension.DomainTypeAware> P create(@NonNull
                                                                                                                                                    P businessInstance)

Description copied from interface: MappableCrudEntityService

Create an instance of an entity based on a business instance containing relevant property values. In this case, the implementation should be aware of the back repository entity type. This is generally discovered via repository implementations that use the DomainTypeAware interface.

Specified by:

create in interface MappableCrudEntityService<P>

Parameters:

businessInstance - The business domain instance. In general, the DomainMapperManager is responsible for converting to a repository platform type for persistence.

Returns:

The new entity instance in the form of a business type instance.

See Also:

MappableCrudEntityService.createAll(List), MappableCrudEntityService.createAllAllowingPartialSuccess(List)

createAll

public <D,R extends org.springframework.data.repository.CrudRepository<D,String> & com.broadleafcommerce.common.extension.DomainTypeAware> List<P> createAll(List<P> businessInstances)

Description copied from interface: MappableCrudEntityService

Create multiple instances of an entity at once based on the business instances containing relevant property values.

All items contained within businessInstances must pass validation, else the entire batch will fail.

See MappableCrudEntityService.createAllAllowingPartialSuccess(List) for an alternative where partial success is allowed.

Specified by:

createAll in interface MappableCrudEntityService<P>

Parameters:

businessInstances - all instances to create in the data store

Returns:

all of the created entity instances in the form of a payload instance

See Also:

MappableCrudEntityService.createAllAllowingPartialSuccess(List)

createAllAllowingPartialSuccess

public <D,R extends org.springframework.data.repository.CrudRepository<D,String> & com.broadleafcommerce.common.extension.DomainTypeAware> BulkPersistenceResponse<P> createAllAllowingPartialSuccess(List<P> businessInstances)

Description copied from interface: MappableCrudEntityService

Creates multiple instances of an entity at once based on the business instances containing relevant property values.

Each item contained within businessInstances will be validated, and if it fails validation, it will be added to the failed list in the response and not persisted. All successfully validated items will be persisted.

See MappableCrudEntityService.createAll(List) for an alternative that does not allow partial success.

Specified by:

createAllAllowingPartialSuccess in interface MappableCrudEntityService<P>

Parameters:

businessInstances - all instances to create in the data store

Returns:

a response containing a list of any entities which failed, and a list of the successfully created entity instances in the form of a payload instance

See Also:

MappableCrudEntityService.createAll(List)

delete

public void delete(@NonNull
                   String id)

Description copied from interface: MappableCrudEntityService

Perform a delete operation on the entity identified by the id.

Specified by:

delete in interface MappableCrudEntityService<P>

Parameters:

id - The id for the entity.

convertFromPersistentDomain

protected P convertFromPersistentDomain(Object domain)

getRepository

@NonNull
protected org.springframework.data.repository.PagingAndSortingRepository<?,String> getRepository()

getHelper

@NonNull
protected MappableCrudEntityHelper getHelper()