io.spine.server.storage

Class RecordStorage<I>

java.lang.Object

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

io.spine.server.storage.RecordStorage<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

Direct Known Subclasses:

InMemoryRecordStorage, ProjectionStorage

public abstract class RecordStorage<I>
extends AbstractStorage<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>
implements StorageWithLifecycleFlags<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>

A storage keeping messages with identity.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecordStorage(java.lang.Class<? extends Entity<?,?>> entityClass, boolean multitenant) Creates an instance of RecordStorage.

Method Summary

Modifier and Type	Method and Description
protected com.google.common.collect.ImmutableList<Column>	columnList() Obtains a list of columns of the managed Entity.
abstract boolean	delete(I id) Deletes the record with the passed ID.
java.util.Optional<io.spine.server.entity.EntityRecord>	read(RecordReadRequest<I> request) Reads a record which matches the specified request.
java.util.Optional<io.spine.server.entity.EntityRecord>	read(RecordReadRequest<I> request, com.google.protobuf.FieldMask fieldMask) Reads a record which matches the specified request and applies a FieldMask to it.
java.util.Iterator<io.spine.server.entity.EntityRecord>	readAll(EntityQuery<I> query) Reads all the records matching the given EntityQuery and applies the given FieldMask to the resulting record states.
java.util.Iterator<io.spine.server.entity.EntityRecord>	readAll(EntityQuery<I> query, io.spine.client.ResponseFormat format) Reads all the records matching the given EntityQuery and applies the given FieldMask to the resulting record states.
java.util.Iterator<io.spine.server.entity.EntityRecord>	readAll(io.spine.client.ResponseFormat format) Reads all active items from the storage and apply FieldMask to each of the results.
protected abstract 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 abstract java.util.Iterator<io.spine.server.entity.EntityRecord>	readAllRecords(io.spine.client.ResponseFormat format) Obtains an iterator for reading all records.
java.util.Optional<io.spine.server.entity.LifecycleFlags>	readLifecycleFlags(I id) Reads the lifecycle status for the entity with the passed ID.
java.util.Iterator<io.spine.server.entity.EntityRecord>	readMultiple(java.lang.Iterable<I> ids, com.google.protobuf.FieldMask fieldMask) Reads multiple active items from the storage and applies FieldMask to the results.
protected abstract java.util.Iterator<io.spine.server.entity.EntityRecord>	readMultipleRecords(java.lang.Iterable<I> ids, com.google.protobuf.FieldMask fieldMask) Obtains an iterator for reading multiple records by IDs, and applying the passed field mask to the results.
protected abstract java.util.Optional<io.spine.server.entity.EntityRecord>	readRecord(I id) Reads a record from the storage by the passed ID.
void	write(I id, io.spine.server.entity.EntityRecord record) Writes a record into the storage.
void	write(I id, EntityRecordWithColumns record) Writes a record and its columns into the storage.
void	write(java.util.Map<I,EntityRecordWithColumns> records) Writes a bulk of records into the storage.
void	writeLifecycleFlags(I id, io.spine.server.entity.LifecycleFlags flags) Writes the lifecycle status for the entity with the passed ID.
protected abstract void	writeRecord(I id, EntityRecordWithColumns record) Writes a record and the associated column values into the storage.
protected abstract void	writeRecords(java.util.Map<I,EntityRecordWithColumns> records) Writes a bulk of records into the storage.

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

RecordStorage

protected RecordStorage(java.lang.Class<? extends Entity<?,?>> entityClass,
                        boolean multitenant)

Creates an instance of RecordStorage.

Method Detail

read

public java.util.Optional<io.spine.server.entity.EntityRecord> read(RecordReadRequest<I> request)

Reads a record which matches the specified request.

Specified by:

read in interface Storage<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>

Parameters:

request - the request to read the record

Returns:

a record instance or Optional.empty() if there is no record with this ID

read

public java.util.Optional<io.spine.server.entity.EntityRecord> read(RecordReadRequest<I> request,
                                                                    com.google.protobuf.FieldMask fieldMask)

Reads a record which matches the specified request and applies a FieldMask to it.

Parameters:

request - the request to read the record

fieldMask - fields to read.

Returns:

the item with the given ID and with the FieldMask applied or Optional.empty() if there is no record matching this request

See Also:

RecordStorage.read(RecordReadRequest)

write

public void write(I id,
                  EntityRecordWithColumns record)

Writes a record and its columns into the storage.

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

Parameters:

id - the ID for the record

record - the record to store

Throws:

java.lang.IllegalStateException - if the storage is closed

See Also:

RecordStorage.write(Object, EntityRecord)

write

public void write(I id,
                  io.spine.server.entity.EntityRecord record)

Description copied from interface: Storage

Writes a record into the storage.

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

Specified by:

write in interface Storage<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>

Parameters:

id - the ID for the record

record - the record to store

write

public void write(java.util.Map<I,EntityRecordWithColumns> records)

Writes a bulk of records into the storage.

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

Parameters:

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

Throws:

java.lang.IllegalStateException - if the storage is closed

readLifecycleFlags

public java.util.Optional<io.spine.server.entity.LifecycleFlags> readLifecycleFlags(I id)

Description copied from interface: StorageWithLifecycleFlags

Reads the lifecycle status for the entity with the passed ID.

This method returns Optional.empty() if none of the flags were set before.

Specified by:

readLifecycleFlags in interface StorageWithLifecycleFlags<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>

Parameters:

id - the ID of the entity

Returns:

the aggregate lifecycle flags or Optional.empty()

writeLifecycleFlags

public void writeLifecycleFlags(I id,
                                io.spine.server.entity.LifecycleFlags flags)

Description copied from interface: StorageWithLifecycleFlags

Writes the lifecycle status for the entity with the passed ID.

Specified by:

writeLifecycleFlags in interface StorageWithLifecycleFlags<I,io.spine.server.entity.EntityRecord,RecordReadRequest<I>>

Parameters:

id - the ID of the entity for which to update the status

flags - the status to write

delete

public abstract boolean delete(I id)

Deletes the record with the passed ID.

Parameters:

id - the record to delete

Returns:

true if the operation succeeded, false otherwise

readMultiple

public java.util.Iterator<io.spine.server.entity.EntityRecord> readMultiple(java.lang.Iterable<I> ids,
                                                                            com.google.protobuf.FieldMask fieldMask)

Reads multiple active items from the storage and applies FieldMask 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.

Parameters:

ids - the IDs of the items to read

fieldMask - the mask to apply

Returns:

the items with the given IDs and with the given FieldMask applied

readAll

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

Reads all active items from the storage and apply FieldMask to each of the results.

Parameters:

format - the expected format of the response

Returns:

all items from this repository with the given FieldMask applied

readAll

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

Reads all the records matching the given EntityQuery and applies the given FieldMask to the resulting record states.

By default, the entities supporting lifecycle will be returned only if they are active. To get inactive entities, the lifecycle attribute must be set to the provided query.

Parameters:

query - the query to execute

format - the format of the query response

Returns:

the matching records mapped upon their IDs

readAll

public java.util.Iterator<io.spine.server.entity.EntityRecord> readAll(EntityQuery<I> query)

Reads all the records matching the given EntityQuery and applies the given FieldMask to the resulting record states.

By default, if the query does not specify the LifecycleFlags but the entity supports them, all the resulting records are active. Otherwise the records obey the constraints provided by the query.

Parameters:

query - the query to execute

Returns:

the matching records mapped upon their IDs

columnList

protected final com.google.common.collect.ImmutableList<Column> columnList()

Obtains a list of columns of the managed Entity.

See Also:

Column, ColumnOption

readRecord

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

Reads a record from the storage by the passed ID.

Parameters:

id - the ID of the record to load

Returns:

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

readMultipleRecords

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

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.

See Also:

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

readAllRecords

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

Obtains an iterator for reading all records.

Only active entities are returned.

Parameters:

format - the expected format of the query response

See Also:

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

readAllRecords

protected abstract 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.

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.

See Also:

RecordStorage.readAll(EntityQuery, ResponseFormat)

writeRecord

protected abstract void writeRecord(I id,
                                    EntityRecordWithColumns record)

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

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

Parameters:

id - an ID of the record

record - a record to store

writeRecords

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

Writes a bulk of records into the storage.

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

Parameters:

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