io.spine.server.projection

Class ProjectionStorage<I>

java.lang.Object

io.spine.server.storage.AbstractStorage<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>

io.spine.server.storage.RecordStorage<I>

io.spine.server.projection.ProjectionStorage<I>

Type Parameters:

I - the type of stream projection IDs

All Implemented Interfaces:

Storage<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>, StorageWithLifecycleFlags<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>, java.lang.AutoCloseable

Direct Known Subclasses:

InMemoryProjectionStorage

@SPI
public abstract class ProjectionStorage<I>
extends RecordStorage<I>

The storage used by projection repositories for keeping Projections and the timestamp of the last event processed by the projection repository.

This timestamp is used for 'catch-up' operation of the projection repositories.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProjectionStorage(java.lang.Class<? extends Projection<?,?,?>> projectionClass, boolean multitenant)

Method Summary

Modifier and Type	Method and Description
protected java.util.Iterator<io.spine.server.entity.EntityRecord>	readAllRecords(EntityQuery<I> query, io.spine.client.ResponseFormat format) Obtains an iterator for reading records matching the query, and applying the passed field mask to the results.
protected java.util.Optional<io.spine.server.entity.EntityRecord>	readRecord(I id) Reads a record from the storage by the passed ID.
protected abstract RecordStorage<I>	recordStorage() Returns an entity storage implementation.
protected void	writeRecord(I id, EntityRecordWithColumns record) Writes a record and the associated column values into the storage.
protected void	writeRecords(java.util.Map<I,EntityRecordWithColumns> records) Writes a bulk of records into the storage.

Methods inherited from class io.spine.server.storage.RecordStorage

columnList, delete, read, read, readAll, readAll, readAll, readAllRecords, readLifecycleFlags, readMultiple, readMultipleRecords, write, write, write, writeLifecycleFlags

Methods inherited from class io.spine.server.storage.AbstractStorage

checkNotClosed, checkNotClosed, close, isClosed, isMultitenant, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.storage.Storage

close, index, isMultitenant, isOpen

Constructor Detail

ProjectionStorage

protected ProjectionStorage(java.lang.Class<? extends Projection<?,?,?>> projectionClass,
                            boolean multitenant)

Method Detail

readRecord

protected java.util.Optional<io.spine.server.entity.EntityRecord> readRecord(I id)

Description copied from class: RecordStorage

Reads a record from the storage by the passed ID.

Specified by:

readRecord in class RecordStorage<I>

Parameters:

id - the ID of the record to load

Returns:

a record instance or null if there is no record with this ID

writeRecord

protected void writeRecord(I id,
                           EntityRecordWithColumns record)

Description copied from class: RecordStorage

Writes a record and the associated column values into the storage.

Rewrites it if a record with this ID already exists in the storage.

Specified by:

writeRecord in class RecordStorage<I>

Parameters:

id - an ID of the record

record - a record to store

writeRecords

protected void writeRecords(java.util.Map<I,EntityRecordWithColumns> records)

Description copied from class: RecordStorage

Writes a bulk of records into the storage.

Rewrites it if a record with this ID already exists in the storage.

Specified by:

writeRecords in class RecordStorage<I>

Parameters:

records - an ID to record map with the entries to store

readAllRecords

protected java.util.Iterator<io.spine.server.entity.EntityRecord> readAllRecords(EntityQuery<I> query,
                                                                                 io.spine.client.ResponseFormat format)

Description copied from class: RecordStorage

Obtains an iterator for reading records matching the query, and applying the passed field mask to the results.

Returns only active entities if the query does not specify the lifecycle flags. In order to read inactive entities, the corresponding filters must be set to the provided query.

Specified by:

readAllRecords in class RecordStorage<I>

See Also:

RecordStorage.readAll(EntityQuery, ResponseFormat)

recordStorage

protected abstract RecordStorage<I> recordStorage()

Returns an entity storage implementation.