Migrate to the new columns API

Author: dmitrykuzmin

.idea/.name

@@ -32,7 +32,7 @@
 import io.spine.server.aggregate.AggregateStorage;
 import io.spine.server.delivery.InboxStorage;
 import io.spine.server.entity.Entity;
-import io.spine.server.entity.storage.TypeRegistry;
+import io.spine.server.entity.storage.ColumnConversionRules;
 import io.spine.server.projection.Projection;
 import io.spine.server.projection.ProjectionStorage;
 import io.spine.server.storage.RecordStorage;
@@ -43,7 +43,7 @@
 import io.spine.server.storage.datastore.tenant.NamespaceSupplier;
 import io.spine.server.storage.datastore.tenant.NsConverterFactory;
 import io.spine.server.storage.datastore.tenant.PrefixedNsConverterFactory;
-import io.spine.server.storage.datastore.type.DsTypeRegistry;
+import io.spine.server.storage.datastore.type.DsColumnConversionRules;
 import io.spine.server.tenant.TenantIndex;
 
 import java.util.Map;
@@ -86,12 +86,12 @@ public class DatastoreStorageFactory implements StorageFactory {
      */
     private final Map<Class<? extends Storage>, DatastoreWrapper> sysWrappers = newConcurrentMap();
 
-    private final TypeRegistry<Value<?>> typeRegistry;
+    private final ColumnConversionRules<Value<?>> columnConversionRules;
 
     private final NsConverterFactory converterFactory;
 
     protected DatastoreStorageFactory(Builder builder) {
-        this.typeRegistry = builder.typeRegistry;
+        this.columnConversionRules = builder.columnConversionRules;
         this.datastore = builder.datastore;
         this.converterFactory = builder.converterFactory;
     }
@@ -156,8 +156,8 @@ public InboxStorage createInboxStorage(boolean multitenant) {
         return new DsInboxStorage(wrapper, multitenant);
     }
 
-    public TypeRegistry<Value<?>> getTypeRegistry() {
-        return typeRegistry;
+    public ColumnConversionRules<Value<?>> columnConversionRules() {
+        return columnConversionRules;
     }
 
     /**
@@ -168,7 +168,7 @@ S configure(B builder, Class<? extends Entity<I, ?>> cls, ContextSpec context) {
         builder.setModelClass(asEntityClass(cls))
                .setDatastore(wrapperFor(context))
                .setMultitenant(context.isMultitenant())
-               .setColumnTypeRegistry(typeRegistry);
+               .setColumnConversionRules(columnConversionRules);
         S storage = builder.build();
         return storage;
     }
@@ -268,7 +268,7 @@ public static Builder newBuilder() {
     public static class Builder {
 
         private Datastore datastore;
-        private TypeRegistry<Value<?>> typeRegistry;
+        private ColumnConversionRules<Value<?>> columnConversionRules;
         private NamespaceConverter namespaceConverter;
         private NsConverterFactory converterFactory;
 
@@ -296,17 +296,17 @@ public Datastore getDatastore() {
         }
 
         /**
-         * Sets a {@link TypeRegistry} for handling the Entity Columns.
+         * Sets the {@link ColumnConversionRules}.
          *
-         * <p>Default value is {@link DsTypeRegistry}.
+         * <p>Default value is {@link DsColumnConversionRules}.
          *
-         * @param typeRegistry
-         *         the type registry containing all the supported
-         *         {@linkplain io.spine.server.entity.storage.Column column} types
+         * @param columnConversionRules
+         *         the conversion rules for entity columns
          * @return self for method chaining
          */
-        public Builder setTypeRegistry(TypeRegistry<Value<?>> typeRegistry) {
-            this.typeRegistry = checkNotNull(typeRegistry);
+        public Builder
+        setColumnConversionRules(ColumnConversionRules<Value<?>> columnConversionRules) {
+            this.columnConversionRules = checkNotNull(columnConversionRules);
             return this;
         }
 
@@ -335,8 +335,8 @@ public Builder setNamespaceConverter(NamespaceConverter converter) {
          */
         public DatastoreStorageFactory build() {
             checkNotNull(datastore);
-            if (typeRegistry == null) {
-                typeRegistry = new DsTypeRegistry();
+            if (columnConversionRules == null) {
+                columnConversionRules = new DsColumnConversionRules();
             }
             if (namespaceConverter == null) {
                 converterFactory = NsConverterFactory.defaults();

datastore/src/main/java/io/spine/server/storage/datastore/DatastoreStorageFactory.java

@@ -31,10 +31,10 @@
 import io.spine.client.OrderBy;
 import io.spine.client.ResponseFormat;
 import io.spine.server.entity.EntityRecord;
+import io.spine.server.entity.storage.ColumnConversionRules;
 import io.spine.server.entity.storage.EntityQuery;
 import io.spine.server.entity.storage.EntityRecordWithColumns;
 import io.spine.server.entity.storage.QueryParameters;
-import io.spine.server.entity.storage.TypeRegistry;
 import io.spine.server.storage.RecordStorage;
 import io.spine.type.TypeUrl;
 import org.checkerframework.checker.nullness.qual.Nullable;
@@ -70,7 +70,7 @@ public class DsRecordStorage<I> extends RecordStorage<I> {
     private final DsLookupByIds<I> idLookup;
     private final DsLookupByQueries queryLookup;
 
-    private final TypeRegistry<Value<?>> typeRegistry;
+    private final ColumnConversionRules<Value<?>> columnConversionRules;
     private final FilterAdapter columnFilterAdapter;
 
     /**
@@ -93,8 +93,8 @@ protected DsRecordStorage(
         this.typeUrl = TypeUrl.from(b.getDescriptor());
         this.idClass = checkNotNull(b.getIdClass());
         this.datastore = b.getDatastore();
-        this.typeRegistry = checkNotNull(b.getColumnTypeRegistry());
-        this.columnFilterAdapter = FilterAdapter.of(this.typeRegistry);
+        this.columnConversionRules = checkNotNull(b.getColumnConversionRules());
+        this.columnFilterAdapter = FilterAdapter.of(this.columnConversionRules);
         this.idLookup = new DsLookupByIds<>(this.datastore, this.typeUrl);
         this.queryLookup = new DsLookupByQueries(this.datastore, this.typeUrl,
                                                  this.columnFilterAdapter);
@@ -269,7 +269,7 @@ protected Entity entityRecordToEntity(I id, EntityRecordWithColumns record) {
     private void populateFromStorageFields(BaseEntity.Builder<Key, Entity.Builder> entity,
                                            EntityRecordWithColumns record) {
         record.columnNames().forEach(columnName -> {
-            Value<?> columnValue = record.columnValue(columnName, typeRegistry);
+            Value<?> columnValue = record.columnValue(columnName, columnConversionRules);
             entity.set(columnName.value(), columnValue);
         });
     }

datastore/src/main/java/io/spine/server/storage/datastore/DsRecordStorage.java

@@ -25,29 +25,25 @@
 import io.spine.client.Filter;
 import io.spine.protobuf.TypeConverter;
 import io.spine.server.entity.storage.Column;
-import io.spine.server.entity.storage.PersistenceStrategy;
-import io.spine.server.entity.storage.TypeRegistry;
+import io.spine.server.entity.storage.ColumnConversionRules;
+import io.spine.server.entity.storage.ConversionRule;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 
 /**
- * A {@link TypeRegistry} based {@link Filter} to {@link Value} adapter.
+ * A {@link Filter} to {@link Value} adapter based on {@link ColumnConversionRules}.
  */
 final class FilterAdapter {
 
-    private final TypeRegistry<Value<?>> registry;
+    private final ColumnConversionRules<Value<?>> conversionRules;
 
-    /**
-     * Creates a new instance of {@code FilterAdapter} on top of the given
-     * {@link TypeRegistry}.
-     */
-    static FilterAdapter of(TypeRegistry<Value<?>> registry) {
-        return new FilterAdapter(registry);
+    static FilterAdapter of(ColumnConversionRules<Value<?>> conversionRules) {
+        return new FilterAdapter(conversionRules);
     }
 
-    private FilterAdapter(TypeRegistry<Value<?>> registry) {
-        this.registry = registry;
+    private FilterAdapter(ColumnConversionRules<Value<?>> conversionRules) {
+        this.conversionRules = conversionRules;
     }
 
     /**
@@ -68,8 +64,8 @@ Value<?> toValue(Column column, Filter columnFilter) {
         Class<?> columnClass = column.type();
         Object filterValueUnpacked = TypeConverter.toObject(filterValue, columnClass);
 
-        PersistenceStrategy<?, ? extends Value<?>> strategy =
-                registry.persistenceStrategyOf(filterValueUnpacked.getClass());
+        ConversionRule<?, ? extends Value<?>> strategy =
+                conversionRules.of(filterValueUnpacked.getClass());
         checkArgument(strategy != null, "Column of unknown type: %s.", column);
 
         Value<?> result = strategy.applyTo(filterValueUnpacked);

datastore/src/main/java/io/spine/server/storage/datastore/FilterAdapter.java

@@ -25,7 +25,7 @@
 import com.google.protobuf.Descriptors.Descriptor;
 import io.spine.server.entity.Entity;
 import io.spine.server.entity.model.EntityClass;
-import io.spine.server.entity.storage.TypeRegistry;
+import io.spine.server.entity.storage.ColumnConversionRules;
 import io.spine.server.storage.RecordStorage;
 import io.spine.type.TypeUrl;
 
@@ -47,7 +47,7 @@ abstract class RecordStorageBuilder<I,
     private Descriptor descriptor;
     private DatastoreWrapper datastore;
     private boolean multitenant;
-    private TypeRegistry<Value<?>> columnTypeRegistry;
+    private ColumnConversionRules<Value<?>> columnConversionRules;
     private Class<I> idClass;
     private EntityClass<?> entityClass;
 
@@ -132,12 +132,12 @@ public B setMultitenant(boolean multitenant) {
     }
 
     /**
-     * Assigns the type registry of
+     * Assigns the column conversion rules of
      * the {@linkplain io.spine.server.entity.storage.Column entity columns}.
      */
     @CanIgnoreReturnValue
-    public B setColumnTypeRegistry(TypeRegistry<Value<?>> columnTypeRegistry) {
-        this.columnTypeRegistry = checkNotNull(columnTypeRegistry);
+    public B setColumnConversionRules(ColumnConversionRules<Value<?>> columnConversionRules) {
+        this.columnConversionRules = checkNotNull(columnConversionRules);
         return self();
     }
 
@@ -164,11 +164,10 @@ public boolean isMultitenant() {
     }
 
     /**
-     * Obtains the type registry of
-     * the {@linkplain io.spine.server.entity.storage.Column entity columns}.
+     * Obtains the column conversion rules of the storage.
      */
-    public TypeRegistry<Value<?>> getColumnTypeRegistry() {
-        return columnTypeRegistry;
+    public ColumnConversionRules<Value<?>> getColumnConversionRules() {
+        return columnConversionRules;
     }
 
     /**
@@ -188,7 +187,7 @@ public EntityClass<?> getEntityClass() {
     final void checkRequiredFields() {
         checkNotNull(descriptor, "State descriptor is not set.");
         checkNotNull(datastore, "Datastore is not set.");
-        checkNotNull(columnTypeRegistry, "Column type registry is not set.");
+        checkNotNull(columnConversionRules, "Column conversion rules are not set.");
     }
 
     abstract B self();

datastore/src/main/java/io/spine/server/storage/datastore/RecordStorageBuilder.java

@@ -34,91 +34,88 @@
 import com.google.protobuf.Message;
 import com.google.protobuf.Timestamp;
 import io.spine.core.Version;
-import io.spine.server.entity.storage.AbstractTypeRegistry;
-import io.spine.server.entity.storage.PersistenceStrategy;
-import io.spine.server.entity.storage.PersistenceStrategyOfNull;
+import io.spine.server.entity.storage.AbstractColumnConversionRules;
+import io.spine.server.entity.storage.ConversionRule;
 import io.spine.string.Stringifiers;
 
-import java.util.function.Supplier;
-
 import static com.google.cloud.Timestamp.ofTimeSecondsAndNanos;
 
 /**
  * Non-{@code final}, implement to ..., maybe {@link io.spine.annotation.SPI}.
  */
-public class DsTypeRegistry extends AbstractTypeRegistry<Value<?>> {
+public class DsColumnConversionRules extends AbstractColumnConversionRules<Value<?>> {
 
     @Override
     protected void
-    setupCustomStrategies(
-            ImmutableMap.Builder<Class<?>, Supplier<PersistenceStrategy<?, ? extends Value<?>>>> builder) {
-        builder.put(Timestamp.class, DsTypeRegistry::timestampPersistenceStrategy);
-        builder.put(Version.class, DsTypeRegistry::versionPersistenceStrategy);
+    setupCustomRules(
+            ImmutableMap.Builder<Class<?>, ConversionRule<?, ? extends Value<?>>> builder) {
+        builder.put(Timestamp.class, ofTimestamp());
+        builder.put(Version.class, ofVersion());
     }
 
     @Override
-    protected PersistenceStrategy<String, StringValue> stringPersistenceStrategy() {
+    protected ConversionRule<String, StringValue> ofString() {
         return StringValue::of;
     }
 
     @Override
-    protected PersistenceStrategy<Integer, LongValue> integerPersistenceStrategy() {
+    protected ConversionRule<Integer, LongValue> ofInteger() {
         return LongValue::of;
     }
 
     @Override
-    protected PersistenceStrategy<Long, LongValue> longPersistenceStrategy() {
+    protected ConversionRule<Long, LongValue> ofLong() {
         return LongValue::of;
     }
 
     @Override
-    protected PersistenceStrategy<Float, DoubleValue> floatPersistenceStrategy() {
+    protected ConversionRule<Float, DoubleValue> ofFloat() {
         return DoubleValue::of;
     }
 
     @Override
-    protected PersistenceStrategy<Double, DoubleValue> doublePersistenceStrategy() {
+    protected ConversionRule<Double, DoubleValue> ofDouble() {
         return DoubleValue::of;
     }
 
     @Override
-    protected PersistenceStrategy<Boolean, BooleanValue> booleanPersistenceStrategy() {
+    protected ConversionRule<Boolean, BooleanValue> ofBoolean() {
         return BooleanValue::of;
     }
 
     @Override
-    protected PersistenceStrategy<ByteString, BlobValue> byteStringPersistenceStrategy() {
+    protected ConversionRule<ByteString, BlobValue> ofByteString() {
         return bytes -> {
             Blob blob = Blob.copyFrom(bytes.asReadOnlyByteBuffer());
             return BlobValue.of(blob);
         };
     }
 
     @Override
-    protected PersistenceStrategy<Enum<?>, LongValue> enumPersistenceStrategy() {
+    protected ConversionRule<Enum<?>, LongValue> ofEnum() {
         return anEnum -> LongValue.of(anEnum.ordinal());
     }
 
     @Override
-    protected PersistenceStrategy<Message, StringValue> messagePersistenceStrategy() {
+    protected ConversionRule<Message, StringValue> ofMessage() {
         return msg -> {
             String str = Stringifiers.toString(msg);
             return StringValue.of(str);
         };
     }
 
     @Override
-    public PersistenceStrategyOfNull<NullValue> persistenceStrategyOfNull() {
-        return NullValue::of;
+    public ConversionRule<?, ? extends Value<?>> ofNull() {
+        return o -> NullValue.of();
     }
 
-    private static PersistenceStrategy<Timestamp, TimestampValue> timestampPersistenceStrategy() {
+    private static ConversionRule<Timestamp, TimestampValue> ofTimestamp() {
         return timestamp -> TimestampValue.of(
                 ofTimeSecondsAndNanos(timestamp.getSeconds(), timestamp.getNanos())
         );
     }
 
-    private static PersistenceStrategy<Version, LongValue> versionPersistenceStrategy() {
+    private static ConversionRule<Version, LongValue> ofVersion() {
         return version -> LongValue.of(version.getNumber());
     }
 }

…orage/datastore/type/DsTypeRegistry.java …astore/type/DsColumnConversionRules.javadatastore/src/main/java/io/spine/server/storage/datastore/type/DsTypeRegistry.java renamed to datastore/src/main/java/io/spine/server/storage/datastore/type/DsColumnConversionRules.java datastore/src/main/java/io/spine/server/storage/datastore/type/DsTypeRegistry.java renamed to datastore/src/main/java/io/spine/server/storage/datastore/type/DsColumnConversionRules.java

@@ -73,7 +73,7 @@ void testDefaultTypeRegistry() {
                 .newBuilder()
                 .setDatastore(datastore())
                 .build();
-        ColumnTypeRegistry registry = factory.getTypeRegistry();
+        ColumnTypeRegistry registry = factory.columnConversionRules();
         assertNotNull(registry);
     }
 
@@ -83,11 +83,11 @@ void testExtendedTypeRegistry() {
         DatastoreStorageFactory factory = DatastoreStorageFactory
                 .newBuilder()
                 .setDatastore(datastore())
-                .setTypeRegistry(predefinedValuesAnd()
+                .setColumnConversionRules(predefinedValuesAnd()
                                          .put(Byte.class, new ByteColumnType())
                                          .build())
                 .build();
-        ColumnTypeRegistry<?> registry = factory.getTypeRegistry();
+        ColumnTypeRegistry<?> registry = factory.columnConversionRules();
         assertNotNull(registry);
         ColumnType type = registry.get(byteColumn());
         assertNotNull(type);