io.spine.server.storage.memory

Class InMemoryRecordStorage<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.storage.memory.InMemoryRecordStorage<I>

Type Parameters:

I - the type of entity 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

public final class InMemoryRecordStorage<I>
extends RecordStorage<I>

Memory-based implementation of RecordStorage.

Method Summary

Modifier and Type	Method and Description
boolean	delete(I id) Deletes the record with the passed ID.
java.util.Iterator<I>	index() Returns an iterator over identifiers of records in the storage.
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.Iterator<io.spine.server.entity.EntityRecord>	readAllRecords(io.spine.client.ResponseFormat format) Obtains an iterator for reading all records.
protected java.util.Iterator<io.spine.server.entity.EntityRecord>	readMultipleRecords(java.lang.Iterable<I> givenIds, com.google.protobuf.FieldMask fieldMask) Obtains an iterator for reading multiple records by IDs, 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 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, read, read, readAll, readAll, readAll, readLifecycleFlags, readMultiple, 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, isMultitenant, isOpen

Method Detail

index

public java.util.Iterator<I> index()

Description copied from interface: Storage

Returns an iterator over identifiers of records in the storage.

delete

public boolean delete(I id)

Description copied from class: RecordStorage

Deletes the record with the passed ID.

Specified by:

delete in class RecordStorage<I>

Parameters:

id - the record to delete

Returns:

true if the operation succeeded, false otherwise

readMultipleRecords

protected java.util.Iterator<io.spine.server.entity.EntityRecord> readMultipleRecords(java.lang.Iterable<I> givenIds,
                                                                                      com.google.protobuf.FieldMask fieldMask)

Description copied from class: RecordStorage

Obtains an iterator for reading multiple records by IDs, and applying the passed field mask to the results.

The size of the returned Iterator matches the size of the given ids, with nulls in place of missing or inactive entities.

Specified by:

readMultipleRecords in class RecordStorage<I>

See Also:

BulkStorageOperationsMixin.readMultiple(java.lang.Iterable<I>, com.google.protobuf.FieldMask)

readAllRecords

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

Description copied from class: RecordStorage

Obtains an iterator for reading all records.

Only active entities are returned.

Specified by:

readAllRecords in class RecordStorage<I>

Parameters:

format - the expected format of the query response

See Also:

BulkStorageOperationsMixin.readAll(io.spine.client.ResponseFormat)

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)

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