Package one.microstream.com

Class ComPersistenceChannel.Abstract<C,D>

java.lang.Object

one.microstream.com.ComPersistenceChannel.Abstract<C,D>

All Implemented Interfaces:

WriteController, ComPersistenceChannel<C,D>, PersistenceChannel<D>, PersistenceSource<D>, PersistenceTarget<D>, PersistenceWriteController

Direct Known Subclasses:

ComPersistenceChannelBinary.Abstract

Enclosing interface:

ComPersistenceChannel<C,D>

public abstract static class ComPersistenceChannel.Abstract<C,D>
extends Object
implements ComPersistenceChannel<C,D>

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.com.ComPersistenceChannel

ComPersistenceChannel.Abstract<C,D>

Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceWriteController

PersistenceWriteController.Disabled, PersistenceWriteController.Enabled, PersistenceWriteController.Wrapper

Constructor Summary

Constructors

Constructor	Description
Abstract()

Method Summary

Modifier and Type	Method	Description
void	closeChannel()
abstract void	closeSource()	Take actions to deactivate/close/destroy the source because it won't be read again.
abstract void	closeTarget()	Take actions to deactivate/close/destroy the target because it won't be written to again.
void	prepareChannel()
abstract void	prepareSource()	Prepare to read from this source.
abstract void	prepareTarget()	Prepare to write to this target.
XGettingCollection<? extends D>	read()	A general, unspecific read, e.g.
XGettingCollection<? extends D>	readByObjectIds(PersistenceIdSet[] objectIds)
void	write(D data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface one.microstream.persistence.types.PersistenceWriteController

isStoringEnabled, validateIsStoringEnabled

Methods inherited from interface one.microstream.afs.WriteController

isWritable, validateIsWritable

Constructor Details

Abstract

public Abstract()

Method Details

read

public XGettingCollection<? extends D> read() throws PersistenceExceptionTransfer

Description copied from interface: PersistenceSource

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.

Specified by:

read in interface PersistenceSource<C>

Returns:

data segments containing general data if applicable, otherwise null.

Throws:

PersistenceExceptionTransfer

write

public void write(D data) throws PersistenceExceptionTransfer

Specified by:

write in interface PersistenceTarget<C>

Throws:

PersistenceExceptionTransfer

prepareChannel

public void prepareChannel()

Specified by:

prepareChannel in interface PersistenceChannel<C>

closeChannel

public void closeChannel()

Specified by:

closeChannel in interface PersistenceChannel<C>

prepareSource

public abstract void prepareSource()

Description copied from interface: PersistenceSource

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

Specified by:

prepareSource in interface PersistenceSource<C>

prepareTarget

public abstract void prepareTarget()

Description copied from interface: PersistenceTarget

Prepare to write to this target. E.g. open a defined file.

Specified by:

prepareTarget in interface PersistenceTarget<C>

closeSource

public abstract void closeSource()

Description copied from interface: PersistenceSource

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

Specified by:

closeSource in interface PersistenceSource<C>

closeTarget

public abstract void closeTarget()

Description copied from interface: PersistenceTarget

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

Specified by:

closeTarget in interface PersistenceTarget<C>

readByObjectIds

public XGettingCollection<? extends D> readByObjectIds(PersistenceIdSet[] objectIds) throws PersistenceExceptionTransfer

Specified by:

readByObjectIds in interface PersistenceSource<C>

Throws:

PersistenceExceptionTransfer