Package ubic.gemma.persistence.service

Class AbstractService<O extends Identifiable>

java.lang.Object

ubic.gemma.persistence.service.AbstractService<O>

Type Parameters:

O - the Identifiable Object type that this service is handling.

All Implemented Interfaces:

BaseImmutableService<O>, BaseReadOnlyService<O>, BaseService<O>

Direct Known Subclasses:

AbstractBulkExpressionDataVectorService, AbstractFilteringVoEnabledService, AbstractVoEnabledService, AnnotationAssociationServiceImpl, AuditTrailServiceImpl, BlatAssociationServiceImpl, ChromosomeServiceImpl, CoexpressionAnalysisServiceImpl, CompoundServiceImpl, DifferentialExpressionAnalysisServiceImpl, DifferentialExpressionResultServiceImpl, ExperimentalDesignServiceImpl, ExpressionExperimentSubSetServiceImpl, ExternalDatabaseServiceImpl, Gene2GOAssociationServiceImpl, GeneDiffExMetaAnalysisServiceImpl, PrincipalComponentAnalysisServiceImpl, ProtocolServiceImpl

public abstract class AbstractService<O extends Identifiable>
extends Object
implements BaseService<O>

Base for all services handling DAO access.

Author:

tesarst

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractService(BaseDao<O> mainDao)

Method Summary

Modifier and Type	Method	Description
long	countAll()
Collection<O>	create(Collection<O> entities)
O	create(O entity)
protected Collection<O>	ensureInSession(Collection<O> entities)	Deprecated. avoid using this if possible and ensure that all operations are properly enclosed by a single Hibernate session
protected O	ensureInSession(O entity)	Deprecated. avoid using this if possible and ensure that all operations are properly enclosed by a single Hibernate session
O	find(O entity)
O	findOrCreate(O entity)
O	findOrFail(O entity)	Does a search for the entity in the persistent storage, raising a NullPointerException if not found.
Class<? extends O>	getElementClass()
O	load(Long id)
Collection<O>	load(Collection<Long> ids)
Collection<O>	loadAll()
O	loadOrFail(Long id)	Load an entity of fail with a NullPointerException if it does not exist in the persistent storage.
<T extends Exception> O	loadOrFail(Long id, Function<String,T> exceptionSupplier)	Load an entity or fail with the supplied exception if it does not exist in the persistent storage.
<T extends Exception> O	loadOrFail(Long id, Function<String,T> exceptionSupplier, String message)	Load an entity or fail with the supplied exception and message.
<T extends Exception> O	loadOrFail(Long id, Supplier<T> exceptionSupplier)	Load an entity or fail with the supplied exception if it does not exist in the persistent storage.
Collection<O>	loadOrFail(Collection<Long> ids)	Load multiple objects or fail with a NullPointerException if any of the objects does not exist in the persistent storage.
<T extends Exception> Collection<O>	loadOrFail(Collection<Long> ids, Function<String,T> exceptionSupplier)
void	remove(Collection<O> entities)
void	remove(O entity)
Collection<O>	save(Collection<O> entities)
O	save(O entity)
Stream<O>	streamAll()
Stream<O>	streamAll(boolean createNewSession)
void	update(Collection<O> entities)
void	update(O entity)

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final org.apache.commons.logging.Log log

Constructor Details

AbstractService

protected AbstractService(BaseDao<O> mainDao)

Method Details

getElementClass

public Class<? extends O> getElementClass()

Specified by:

getElementClass in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.getElementClass()

find

@Transactional(readOnly=true)
public O find(O entity)

Specified by:

find in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.find(Identifiable)

findOrFail

@Nonnull
@Transactional(readOnly=true)
public O findOrFail(O entity)

Description copied from interface: BaseReadOnlyService

Does a search for the entity in the persistent storage, raising a NullPointerException if not found.

Specified by:

findOrFail in interface BaseReadOnlyService<O extends Identifiable>

Parameters:

entity - the entity to be searched for

Returns:

the version of entity retrieved from persistent storage

findOrCreate

@Transactional
public O findOrCreate(O entity)

Specified by:

findOrCreate in interface BaseImmutableService<O extends Identifiable>

See Also:

• BaseDao.findOrCreate(Identifiable)

create

@Transactional
public Collection<O> create(Collection<O> entities)

Specified by:

create in interface BaseImmutableService<O extends Identifiable>

See Also:

• BaseDao.create(Collection)

create

@Transactional
@OverridingMethodsMustInvokeSuper
public O create(O entity)

Specified by:

create in interface BaseImmutableService<O extends Identifiable>

See Also:

• BaseDao.create(Identifiable)

save

@Transactional
public Collection<O> save(Collection<O> entities)

Specified by:

save in interface BaseService<O extends Identifiable>

See Also:

• BaseDao.save(Collection)

save

@Transactional
@OverridingMethodsMustInvokeSuper
public O save(O entity)

Specified by:

save in interface BaseService<O extends Identifiable>

See Also:

• BaseDao.save(Identifiable)

load

@Transactional(readOnly=true)
public Collection<O> load(Collection<Long> ids)

Specified by:

load in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.load(Collection)

loadOrFail

@Transactional(readOnly=true)
public Collection<O> loadOrFail(Collection<Long> ids)
                         throws NullPointerException

Description copied from interface: BaseReadOnlyService

Load multiple objects or fail with a NullPointerException if any of the objects does not exist in the persistent storage.

Specified by:

loadOrFail in interface BaseReadOnlyService<O extends Identifiable>

Throws:

NullPointerException

loadOrFail

@Transactional(readOnly=true)
public <T extends Exception> Collection<O> loadOrFail(Collection<Long> ids,
 Function<String,T> exceptionSupplier)
                                               throws T

Specified by:

loadOrFail in interface BaseReadOnlyService<O extends Identifiable>

Throws:

T

load

@Transactional(readOnly=true)
public O load(Long id)

Specified by:

load in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.load(Long)

loadOrFail

@Nonnull
@Transactional(readOnly=true)
public O loadOrFail(Long id)

Description copied from interface: BaseReadOnlyService

Load an entity of fail with a NullPointerException if it does not exist in the persistent storage.

Specified by:

loadOrFail in interface BaseReadOnlyService<O extends Identifiable>

Parameters:

id - the ID used to retrieve the entity

Returns:

the entity as per BaseReadOnlyService.load(Long), never null

See Also:

• BaseReadOnlyService.load(Long)

loadOrFail

@Nonnull
@Transactional(readOnly=true)
public <T extends Exception> O loadOrFail(Long id,
 Supplier<T> exceptionSupplier)
                                   throws T

Description copied from interface: BaseReadOnlyService

Load an entity or fail with the supplied exception if it does not exist in the persistent storage.

Specified by:

loadOrFail in interface BaseReadOnlyService<O extends Identifiable>

Throws:

T - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadOrFail

@Nonnull
@Transactional(readOnly=true)
public <T extends Exception> O loadOrFail(Long id,
 Function<String,T> exceptionSupplier)
                                   throws T

Description copied from interface: BaseReadOnlyService

Load an entity or fail with the supplied exception if it does not exist in the persistent storage.

The message is generated automatically.

Specified by:

loadOrFail in interface BaseReadOnlyService<O extends Identifiable>

Throws:

T - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadOrFail

@Nonnull
@Transactional(readOnly=true)
public <T extends Exception> O loadOrFail(Long id,
 Function<String,T> exceptionSupplier,
 String message)
                                   throws T

Description copied from interface: BaseReadOnlyService

Load an entity or fail with the supplied exception and message.

Specified by:

loadOrFail in interface BaseReadOnlyService<O extends Identifiable>

Throws:

T - if the entity does not exist in the persistent storage

See Also:

• BaseReadOnlyService.load(Long)

loadAll

@Transactional(readOnly=true)
public Collection<O> loadAll()

Specified by:

loadAll in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.loadAll()

countAll

@Transactional(readOnly=true)
public long countAll()

Specified by:

countAll in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.countAll()

streamAll

@Transactional(readOnly=true)
public Stream<O> streamAll()

Specified by:

streamAll in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.streamAll()

streamAll

@Transactional(readOnly=true)
public Stream<O> streamAll(boolean createNewSession)

Specified by:

streamAll in interface BaseReadOnlyService<O extends Identifiable>

See Also:

• BaseDao.streamAll(boolean)

remove

@Transactional
public void remove(Collection<O> entities)

Specified by:

remove in interface BaseImmutableService<O extends Identifiable>

See Also:

• BaseDao.remove(Collection)

remove

@Transactional
@OverridingMethodsMustInvokeSuper
public void remove(O entity)

Specified by:

remove in interface BaseImmutableService<O extends Identifiable>

See Also:

• BaseDao.remove(Identifiable)

update

@Transactional
public void update(Collection<O> entities)

Specified by:

update in interface BaseService<O extends Identifiable>

See Also:

• BaseDao.update(Collection)

update

@Transactional
@OverridingMethodsMustInvokeSuper
public void update(O entity)

Specified by:

update in interface BaseService<O extends Identifiable>

See Also:

• BaseDao.update(Identifiable)

ensureInSession

@Deprecated
@CheckReturnValue
protected O ensureInSession(O entity)

Deprecated.

avoid using this if possible and ensure that all operations are properly enclosed by a single Hibernate session

Ensure that a given entity is in the current session.

If not found in the current session, it will be retrieved from the persistent storage.

ensureInSession

@Deprecated
@CheckReturnValue
protected Collection<O> ensureInSession(Collection<O> entities)

Deprecated.

avoid using this if possible and ensure that all operations are properly enclosed by a single Hibernate session

Ensure that a collection of entities are in the current session.

Implementation note: if all entities are already in the session - or are transient, this call is very fast and does not involve any database interaction, otherwise the persistent entities are fetched in bulk.

See Also:

• ensureInSession(Identifiable)