io.spine.server.entity.storage

Class EntityRecordWithColumns

java.lang.Object

io.spine.server.entity.storage.EntityRecordWithColumns

All Implemented Interfaces:

WithLifecycle

public final class EntityRecordWithColumns
extends java.lang.Object
implements WithLifecycle

A value of EntityRecord associated with the values of its columns.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<ColumnName>	columnNames() Obtains the names of storage fields in the record.
@Nullable java.lang.Object	columnValue(ColumnName columnName) Obtains the value of the storage field by the specified column name.
<R> R	columnValue(ColumnName columnName, ColumnMapping<R> columnMapping) Obtains the value of the storage field by the specified column name.
static EntityRecordWithColumns	create(io.spine.server.entity.EntityRecord record, Entity<?,?> entity, RecordStorage<?> recordStorage) Creates a new record extracting the column values from the passed entity.
boolean	equals(java.lang.Object o)
io.spine.server.entity.LifecycleFlags	getLifecycleFlags() Obtains current lifecycle flags.
boolean	hasColumn(ColumnName name) Determines if there is a column with the specified name among the storage fields.
boolean	hasColumns() Determines if there are any columns associated with this record.
int	hashCode()
boolean	isActive() Verifies if any of the lifecycle attributes is set.
boolean	isArchived() Shows if current instance is marked as archived or not.
boolean	isDeleted() Shows if current instance is marked as deleted or not.
static EntityRecordWithColumns	of(io.spine.server.entity.EntityRecord record) Wraps a passed entity record.
static EntityRecordWithColumns	of(io.spine.server.entity.EntityRecord record, java.util.Map<ColumnName,java.lang.Object> storageFields) Creates a new instance from the passed record and storage fields.
io.spine.server.entity.EntityRecord	record() Returns the enclosed entity record.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.entity.WithLifecycle

lifecycleFlags

Method Detail

create

public static EntityRecordWithColumns create(io.spine.server.entity.EntityRecord record,
                                             Entity<?,?> entity,
                                             RecordStorage<?> recordStorage)

Creates a new record extracting the column values from the passed entity.

of

public static EntityRecordWithColumns of(io.spine.server.entity.EntityRecord record)

Wraps a passed entity record.

Such instance of EntityRecordWithColumns will contain no storage fields.

of

public static EntityRecordWithColumns of(io.spine.server.entity.EntityRecord record,
                                         java.util.Map<ColumnName,java.lang.Object> storageFields)

Creates a new instance from the passed record and storage fields.

record

public io.spine.server.entity.EntityRecord record()

Returns the enclosed entity record.

columnNames

public com.google.common.collect.ImmutableSet<ColumnName> columnNames()

Obtains the names of storage fields in the record.

Returns:

the storage field names

columnValue

public @Nullable java.lang.Object columnValue(ColumnName columnName)

Obtains the value of the storage field by the specified column name.

The default column mapping will be used. It is suitable for storages that store values "as-is" or that are willing to do the manual column value conversion.

In other cases consider implementing a custom ColumnMapping and using the EntityRecordWithColumns.columnValue(ColumnName, ColumnMapping) overload for convenient column value conversion.

Parameters:

columnName - the column name

Returns:

the storage field value

Throws:

java.lang.IllegalStateException - if there is no column with the specified name

columnValue

public <R> R columnValue(ColumnName columnName,
                         ColumnMapping<R> columnMapping)

Obtains the value of the storage field by the specified column name.

The specified column mapping will be used to do the column value conversion.

hasColumns

public boolean hasColumns()

Determines if there are any columns associated with this record.

If returns false, the columns are not considered by the storage.

Returns:

true if the object was constructed using EntityRecordWithColumns.create(EntityRecord, Entity, RecordStorage) and the entity has columns; false otherwise

hasColumn

public boolean hasColumn(ColumnName name)

Determines if there is a column with the specified name among the storage fields.

getLifecycleFlags

public io.spine.server.entity.LifecycleFlags getLifecycleFlags()

Description copied from interface: WithLifecycle

Obtains current lifecycle flags.

Specified by:

getLifecycleFlags in interface WithLifecycle

See Also:

WithLifecycle.lifecycleFlags()

isArchived

public boolean isArchived()

Description copied from interface: WithLifecycle

Shows if current instance is marked as archived or not.

Specified by:

isArchived in interface WithLifecycle

isDeleted

public boolean isDeleted()

Description copied from interface: WithLifecycle

Shows if current instance is marked as deleted or not.

Specified by:

isDeleted in interface WithLifecycle

isActive

public boolean isActive()

Description copied from interface: WithLifecycle

Verifies if any of the lifecycle attributes is set.

Specified by:

isActive in interface WithLifecycle

Returns:

false if any of the attributes is set, true otherwise

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object