server/io.spine.server.entity.storage/InterfaceBasedColumn

InterfaceBasedColumn

public final class InterfaceBasedColumn extends AbstractColumn implements ColumnDeclaredInProto, ColumnWithCustomGetter

A column declared with the help of io.spine.base.EntityWithColumns-derived interface.

An interface-based column is:

Declared in Protobuf with (column) option:

        int32 year_of_registration = 8 [(column) = true];

Implemented using custom Spine-generated interface:

        interface UserProfileWithColumns extends EntityWithColumns {
            int getYearOfRegistration();
        }

        // ...
        class UserProfileProjection
extends Projection<UserId, UserProfile, UserProfile.Builder>
            implements UserProfileWithColumns {

           @Override
            public int getYearOfRegistration() {
                return yearOfRegistration;
            }
        }

Extracted from the entity and propagated to the entity state at the moment of transaction commit. The column value is finalized by this moment.

Functions

protoField

public FieldDeclaration protoField()

Obtains the corresponding proto field declaration.

valueIn

public Object valueIn(EntityState state)

Extracts the column value currently stored in the entity state.

public Object valueIn(Entity<? extends Object, ? extends Object> entity)

Extracts the actual column value from the source.

Inherited functions

name

public ColumnName name()

The name of the column in the storage.

type

public Class<? extends Object> type()

The type of the column.