one.microstream.persistence.types

Interface PersistenceSource<D>

All Known Subinterfaces:

PersistenceChannel<D>

public interface PersistenceSource<D>

Method Summary

Modifier and Type	Method and Description
default void	closeSource() Take actions to deactivate/close/destroy the source because it won't be read again.
default void	prepareSource() Prepare to read from this source.
one.microstream.collections.types.XGettingCollection<? extends D>	read() A general, unspecific read, e.g.
one.microstream.collections.types.XGettingCollection<? extends D>	readByObjectIds(PersistenceIdSet[] oids)

Method Detail

read

one.microstream.collections.types.XGettingCollection<? extends D> read()
                                                                throws PersistenceExceptionTransfer

A general, unspecific read, e.g. to initially read data in general from the attached data source.

Examples:

• simply ALL data from a plain file.
• only root nodes (and all recursively referenced nodes) of a graph-based database.
• nothing at all if not applicable, resulting in null being returned.

Returns:

data segments containing general data if applicable, otherwise null.

Throws:

PersistenceExceptionTransfer - if a transfer error occurs

readByObjectIds

one.microstream.collections.types.XGettingCollection<? extends D> readByObjectIds(PersistenceIdSet[] oids)
                                                                           throws PersistenceExceptionTransfer

Throws:

PersistenceExceptionTransfer

prepareSource

default void prepareSource()

Prepare to read from this source. E.g. open a defined file.

closeSource

default void closeSource()

Take actions to deactivate/close/destroy the source because it won't be read again.