Package ubic.gemma.persistence.service

Interface BaseReadOnlyService<O extends Identifiable>

All Known Subinterfaces:

AdminEditableBaseImmutableService<O>, AdminEditableBaseService<O>, AnalysisResultSetService<K,O>, AnalysisService<T>, AnnotationAssociationService, ArrayDesignService, AuditTrailService, BaseImmutableService<O>, BaseService<O>, BaseVoEnabledService<O,VO>, BibliographicReferenceService, BioAssayDimensionService, BioAssayService, BioMaterialService, BioSequenceService, BlacklistedEntityService, BlatAssociationService, BlatResultService, BulkExpressionDataVectorService<T>, CharacteristicService, ChromosomeService, CoexpressionAnalysisService, CompositeSequenceService, CompoundService, DatabaseEntryService, DifferentialExpressionAnalysisService, DifferentialExpressionResultService, ExperimentalDesignService, ExperimentalFactorService, ExpressionAnalysisResultSetService, ExpressionExperimentService, ExpressionExperimentSetService, ExpressionExperimentSubSetService, ExternalDatabaseService, FactorValueService, FilteringService<O>, FilteringVoEnabledService<O,VO>, GeeqService, Gene2GOAssociationService, GeneDiffExMetaAnalysisService, GeneProductService, GeneService, GeneSetService, PrincipalComponentAnalysisService, ProcessedExpressionDataVectorService, ProtocolService, QuantitationTypeService, RawAndProcessedExpressionDataVectorService, RawExpressionDataVectorService, SecurableBaseImmutableService<C>, SecurableBaseReadOnlyService<C>, SecurableBaseService<C>, SecurableBaseVoEnabledService<C,VO>, SecurableFilteringVoEnabledService<C,VO>, TaxonService

All Known Implementing Classes:

AbstractBulkExpressionDataVectorService, AbstractFilteringVoEnabledService, AbstractService, AbstractVoEnabledService, AnnotationAssociationServiceImpl, ArrayDesignServiceImpl, AuditTrailServiceImpl, BibliographicReferenceServiceImpl, BioAssayDimensionServiceImpl, BioAssayServiceImpl, BioMaterialServiceImpl, BioSequenceServiceImpl, BlacklistedEntityServiceImpl, BlatAssociationServiceImpl, BlatResultServiceImpl, CharacteristicServiceImpl, ChromosomeServiceImpl, CoexpressionAnalysisServiceImpl, CompositeSequenceServiceImpl, CompoundServiceImpl, DatabaseEntryServiceImpl, DifferentialExpressionAnalysisServiceImpl, DifferentialExpressionResultServiceImpl, ExperimentalDesignServiceImpl, ExperimentalFactorServiceImpl, ExpressionAnalysisResultSetServiceImpl, ExpressionExperimentServiceImpl, ExpressionExperimentSetServiceImpl, ExpressionExperimentSubSetServiceImpl, ExternalDatabaseServiceImpl, FactorValueServiceImpl, GeeqServiceImpl, Gene2GOAssociationServiceImpl, GeneDiffExMetaAnalysisServiceImpl, GeneProductServiceImpl, GeneServiceImpl, GeneSetServiceImpl, PrincipalComponentAnalysisServiceImpl, ProcessedExpressionDataVectorServiceImpl, ProtocolServiceImpl, QuantitationTypeServiceImpl, RawAndProcessedExpressionDataVectorServiceImpl, RawExpressionDataVectorServiceImpl, TaxonServiceImpl

public interface BaseReadOnlyService<O extends Identifiable>

Interface for read-only services.

Author:

poirigui

Method Summary

Modifier and Type	Method	Description
long	countAll()
O	find(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)
Stream<O>	streamAll()
Stream<O>	streamAll(boolean createNewSession)

Method Details

getElementClass

Class<? extends O> getElementClass()

See Also:

• BaseDao.getElementClass()

find

@Nullable
@CheckReturnValue
O find(O entity)

See Also:

• BaseDao.find(Identifiable)

findOrFail

@Nonnull
@CheckReturnValue
O findOrFail(O entity)
      throws NullPointerException

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

Parameters:

entity - the entity to be searched for

Returns:

the version of entity retrieved from persistent storage

Throws:

NullPointerException - if the entity is not found

load

Collection<O> load(Collection<Long> ids)

See Also:

• BaseDao.load(Collection)

loadOrFail

Collection<O> loadOrFail(Collection<Long> ids)
                  throws NullPointerException

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

Throws:

NullPointerException

loadOrFail

<T extends Exception> Collection<O> loadOrFail(Collection<Long> ids,
 Function<String,T> exceptionSupplier)
                                        throws T

Throws:

T

load

@Nullable
O load(Long id)

See Also:

• BaseDao.load(Long)

loadOrFail

@Nonnull
O loadOrFail(Long id)
      throws NullPointerException

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

Parameters:

id - the ID used to retrieve the entity

Returns:

the entity as per load(Long), never null

Throws:

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

See Also:

• load(Long)

loadOrFail

@Nonnull
<T extends Exception> O loadOrFail(Long id,
 Supplier<T> exceptionSupplier)
                            throws T

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

Throws:

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

See Also:

• load(Long)

loadOrFail

@Nonnull
<T extends Exception> O loadOrFail(Long id,
 Function<String,T> exceptionSupplier)
                            throws T

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

The message is generated automatically.

Throws:

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

See Also:

• load(Long)

loadOrFail

@Nonnull
<T extends Exception> O loadOrFail(Long id,
 Function<String,T> exceptionSupplier,
 String message)
                            throws T

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

Throws:

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

See Also:

• load(Long)

loadAll

Collection<O> loadAll()

See Also:

• BaseDao.loadAll()

countAll

long countAll()

See Also:

• BaseDao.countAll()

streamAll

Stream<O> streamAll()

See Also:

• BaseDao.streamAll()

streamAll

Stream<O> streamAll(boolean createNewSession)

See Also:

• BaseDao.streamAll(boolean)