Migrate to the refactored column API

Author: dmitrykuzmin

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

@@ -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.ColumnStorageRules;
+import io.spine.server.entity.storage.ColumnMapping;
 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.DsStorageRules;
+import io.spine.server.storage.datastore.type.DsColumnMapping;
 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 ColumnStorageRules<Value<?>> columnStorageRules;
+    private final ColumnMapping<Value<?>> columnMapping;
 
     private final NsConverterFactory converterFactory;
 
     protected DatastoreStorageFactory(Builder builder) {
-        this.columnStorageRules = builder.columnStorageRules;
+        this.columnMapping = builder.columnMapping;
         this.datastore = builder.datastore;
         this.converterFactory = builder.converterFactory;
     }
@@ -156,8 +156,8 @@ public InboxStorage createInboxStorage(boolean multitenant) {
         return new DsInboxStorage(wrapper, multitenant);
     }
 
-    public ColumnStorageRules<Value<?>> columnStorageRules() {
-        return columnStorageRules;
+    public ColumnMapping<Value<?>> columnMapping() {
+        return columnMapping;
     }
 
     /**
@@ -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())
-               .setColumnStorageRules(columnStorageRules);
+               .setColumnMapping(columnMapping);
         S storage = builder.build();
         return storage;
     }
@@ -268,7 +268,7 @@ public static Builder newBuilder() {
     public static class Builder {
 
         private Datastore datastore;
-        private ColumnStorageRules<Value<?>> columnStorageRules;
+        private ColumnMapping<Value<?>> columnMapping;
         private NamespaceConverter namespaceConverter;
         private NsConverterFactory converterFactory;
 
@@ -296,17 +296,17 @@ public Datastore getDatastore() {
         }
 
         /**
-         * Sets the {@link ColumnStorageRules}.
+         * Sets the {@link ColumnMapping}.
          *
-         * <p>Default value is {@link DsStorageRules}.
+         * <p>Default value is {@link DsColumnMapping}.
          *
-         * @param columnStorageRules
+         * @param columnMapping
          *         the storage rules for entity columns
          * @return self for method chaining
          */
         public Builder
-        setColumnStorageRules(ColumnStorageRules<Value<?>> columnStorageRules) {
-            this.columnStorageRules = checkNotNull(columnStorageRules);
+        setColumnMapping(ColumnMapping<Value<?>> columnMapping) {
+            this.columnMapping = checkNotNull(columnMapping);
             return this;
         }
 
@@ -335,8 +335,8 @@ public Builder setNamespaceConverter(NamespaceConverter converter) {
          */
         public DatastoreStorageFactory build() {
             checkNotNull(datastore);
-            if (columnStorageRules == null) {
-                columnStorageRules = new DsStorageRules();
+            if (columnMapping == null) {
+                columnMapping = new DsColumnMapping();
             }
             if (namespaceConverter == null) {
                 converterFactory = NsConverterFactory.defaults();

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

@@ -31,7 +31,7 @@
 import io.spine.client.OrderBy;
 import io.spine.client.ResponseFormat;
 import io.spine.server.entity.EntityRecord;
-import io.spine.server.entity.storage.ColumnStorageRules;
+import io.spine.server.entity.storage.ColumnMapping;
 import io.spine.server.entity.storage.EntityQuery;
 import io.spine.server.entity.storage.EntityRecordWithColumns;
 import io.spine.server.entity.storage.QueryParameters;
@@ -70,7 +70,7 @@ public class DsRecordStorage<I> extends RecordStorage<I> {
     private final DsLookupByIds<I> idLookup;
     private final DsLookupByQueries queryLookup;
 
-    private final ColumnStorageRules<Value<?>> columnStorageRules;
+    private final ColumnMapping<Value<?>> columnMapping;
     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.columnStorageRules = checkNotNull(b.getColumnStorageRules());
-        this.columnFilterAdapter = FilterAdapter.of(this.columnStorageRules);
+        this.columnMapping = checkNotNull(b.getColumnMapping());
+        this.columnFilterAdapter = FilterAdapter.of(this.columnMapping);
         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, columnStorageRules);
+            Value<?> columnValue = record.columnValue(columnName, columnMapping);
             entity.set(columnName.value(), columnValue);
         });
     }

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

@@ -25,25 +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.ColumnStorageRule;
-import io.spine.server.entity.storage.ColumnStorageRules;
+import io.spine.server.entity.storage.ColumnMapping;
+import io.spine.server.entity.storage.ColumnTypeMapping;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 
 /**
- * A {@link Filter} to {@link Value} adapter based on {@link ColumnStorageRules}.
+ * A {@link Filter} to {@link Value} adapter based on {@link ColumnMapping}.
  */
 final class FilterAdapter {
 
-    private final ColumnStorageRules<Value<?>> columnStorageRules;
+    private final ColumnMapping<Value<?>> columnMapping;
 
-    static FilterAdapter of(ColumnStorageRules<Value<?>> columnStorageRules) {
-        return new FilterAdapter(columnStorageRules);
+    static FilterAdapter of(ColumnMapping<Value<?>> columnMapping) {
+        return new FilterAdapter(columnMapping);
     }
 
-    private FilterAdapter(ColumnStorageRules<Value<?>> columnStorageRules) {
-        this.columnStorageRules = columnStorageRules;
+    private FilterAdapter(ColumnMapping<Value<?>> columnMapping) {
+        this.columnMapping = columnMapping;
     }
 
     /**
@@ -64,8 +64,8 @@ Value<?> toValue(Column column, Filter columnFilter) {
         Class<?> columnClass = column.type();
         Object filterValueUnpacked = TypeConverter.toObject(filterValue, columnClass);
 
-        ColumnStorageRule<?, ? extends Value<?>> storageRule =
-                columnStorageRules.of(filterValueUnpacked.getClass());
+        ColumnTypeMapping<?, ? extends Value<?>> storageRule =
+                columnMapping.of(filterValueUnpacked.getClass());
         checkArgument(storageRule != null, "Column of unknown type: %s.", column);
 
         Value<?> result = storageRule.applyTo(filterValueUnpacked);

datastore/src/main/java/io/spine/server/storage/datastore/RecordStorageBuilder.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.ColumnStorageRules;
+import io.spine.server.entity.storage.ColumnMapping;
 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 ColumnStorageRules<Value<?>> columnStorageRules;
+    private ColumnMapping<Value<?>> columnMapping;
     private Class<I> idClass;
     private EntityClass<?> entityClass;
 
@@ -132,12 +132,12 @@ public B setMultitenant(boolean multitenant) {
     }
 
     /**
-     * Assigns the column storage rules of
+     * Sets the mapping rules of
      * the {@linkplain io.spine.server.entity.storage.Column entity columns}.
      */
     @CanIgnoreReturnValue
-    public B setColumnStorageRules(ColumnStorageRules<Value<?>> columnStorageRules) {
-        this.columnStorageRules = checkNotNull(columnStorageRules);
+    public B setColumnMapping(ColumnMapping<Value<?>> columnMapping) {
+        this.columnMapping = checkNotNull(columnMapping);
         return self();
     }
 
@@ -164,10 +164,10 @@ public boolean isMultitenant() {
     }
 
     /**
-     * Obtains the column storage rules of the storage.
+     * Obtains the column mapping used in the storage.
      */
-    public ColumnStorageRules<Value<?>> getColumnStorageRules() {
-        return columnStorageRules;
+    public ColumnMapping<Value<?>> getColumnMapping() {
+        return columnMapping;
     }
 
     /**
@@ -187,7 +187,7 @@ public EntityClass<?> getEntityClass() {
     final void checkRequiredFields() {
         checkNotNull(descriptor, "State descriptor is not set.");
         checkNotNull(datastore, "Datastore is not set.");
-        checkNotNull(columnStorageRules, "Column storage rules are not set.");
+        checkNotNull(columnMapping, "Column mapping is not set.");
     }
 
     abstract B self();

…orage/datastore/type/DsStorageRules.java …rage/datastore/type/DsColumnMapping.javadatastore/src/main/java/io/spine/server/storage/datastore/type/DsStorageRules.java renamed to datastore/src/main/java/io/spine/server/storage/datastore/type/DsColumnMapping.java datastore/src/main/java/io/spine/server/storage/datastore/type/DsStorageRules.java renamed to datastore/src/main/java/io/spine/server/storage/datastore/type/DsColumnMapping.java

@@ -34,89 +34,89 @@
 import com.google.protobuf.Message;
 import com.google.protobuf.Timestamp;
 import io.spine.core.Version;
-import io.spine.server.entity.storage.AbstractStorageRules;
-import io.spine.server.entity.storage.ColumnStorageRule;
+import io.spine.server.entity.storage.AbstractColumnMapping;
+import io.spine.server.entity.storage.ColumnTypeMapping;
 import io.spine.string.Stringifiers;
 
 import static com.google.cloud.Timestamp.ofTimeSecondsAndNanos;
 
 /**
  * Non-{@code final}, implement to ..., maybe {@link io.spine.annotation.SPI}.
  */
-public class DsStorageRules extends AbstractStorageRules<Value<?>> {
+public class DsColumnMapping extends AbstractColumnMapping<Value<?>> {
 
     @Override
     protected void
-    setupCustomRules(
-            ImmutableMap.Builder<Class<?>, ColumnStorageRule<?, ? extends Value<?>>> builder) {
+    setupCustomMapping(
+            ImmutableMap.Builder<Class<?>, ColumnTypeMapping<?, ? extends Value<?>>> builder) {
         builder.put(Timestamp.class, ofTimestamp());
         builder.put(Version.class, ofVersion());
     }
 
     @Override
-    protected ColumnStorageRule<String, StringValue> ofString() {
+    protected ColumnTypeMapping<String, StringValue> ofString() {
         return StringValue::of;
     }
 
     @Override
-    protected ColumnStorageRule<Integer, LongValue> ofInteger() {
+    protected ColumnTypeMapping<Integer, LongValue> ofInteger() {
         return LongValue::of;
     }
 
     @Override
-    protected ColumnStorageRule<Long, LongValue> ofLong() {
+    protected ColumnTypeMapping<Long, LongValue> ofLong() {
         return LongValue::of;
     }
 
     @Override
-    protected ColumnStorageRule<Float, DoubleValue> ofFloat() {
+    protected ColumnTypeMapping<Float, DoubleValue> ofFloat() {
         return DoubleValue::of;
     }
 
     @Override
-    protected ColumnStorageRule<Double, DoubleValue> ofDouble() {
+    protected ColumnTypeMapping<Double, DoubleValue> ofDouble() {
         return DoubleValue::of;
     }
 
     @Override
-    protected ColumnStorageRule<Boolean, BooleanValue> ofBoolean() {
+    protected ColumnTypeMapping<Boolean, BooleanValue> ofBoolean() {
         return BooleanValue::of;
     }
 
     @Override
-    protected ColumnStorageRule<ByteString, BlobValue> ofByteString() {
+    protected ColumnTypeMapping<ByteString, BlobValue> ofByteString() {
         return bytes -> {
             Blob blob = Blob.copyFrom(bytes.asReadOnlyByteBuffer());
             return BlobValue.of(blob);
         };
     }
 
     @Override
-    protected ColumnStorageRule<Enum<?>, LongValue> ofEnum() {
+    protected ColumnTypeMapping<Enum<?>, LongValue> ofEnum() {
         return anEnum -> LongValue.of(anEnum.ordinal());
     }
 
     @Override
-    protected ColumnStorageRule<Message, StringValue> ofMessage() {
+    protected ColumnTypeMapping<Message, StringValue> ofMessage() {
         return msg -> {
             String str = Stringifiers.toString(msg);
             return StringValue.of(str);
         };
     }
 
     @Override
-    public ColumnStorageRule<?, ? extends Value<?>> ofNull() {
+    public ColumnTypeMapping<?, ? extends Value<?>> ofNull() {
         return o -> NullValue.of();
     }
 
     @SuppressWarnings("ProtoTimestampGetSecondsGetNano") // This behavior is intended.
-    private static ColumnStorageRule<Timestamp, TimestampValue> ofTimestamp() {
+    private static ColumnTypeMapping<Timestamp, TimestampValue> ofTimestamp() {
         return timestamp -> TimestampValue.of(
                 ofTimeSecondsAndNanos(timestamp.getSeconds(), timestamp.getNanos())
         );
     }
 
-    private static ColumnStorageRule<Version, LongValue> ofVersion() {
+    private static ColumnTypeMapping<Version, LongValue> ofVersion() {
         return version -> LongValue.of(version.getNumber());
     }
 }