io.spine.server.entity.storage

Class AbstractColumnMapping<R>

java.lang.Object

io.spine.server.entity.storage.AbstractColumnMapping<R>

All Implemented Interfaces:

ColumnMapping<R>

Direct Known Subclasses:

DefaultColumnMapping

public abstract class AbstractColumnMapping<R>
extends java.lang.Object
implements ColumnMapping<R>

The basic implementation of mapping rules for entity columns.

Since entity columns are proto-based and have a limited amount of possible types, this class allows descendants to override concrete type mapping rules in a convenient way.

Some of the types are expected to be mapped in a way so they support the ordering comparison operators ("greater than", "less than or equals", etc.). For details, see Filters.

Constructor Summary

Constructors

Constructor and Description
AbstractColumnMapping()

Method Summary

Modifier and Type	Method and Description
<T> ColumnTypeMapping<T,? extends R>	of(java.lang.Class<T> type) Obtains the mapping rules for the given type.
protected abstract ColumnTypeMapping<java.lang.Boolean,? extends R>	ofBoolean() Returns the mapping rules of Boolean columns.
protected abstract ColumnTypeMapping<com.google.protobuf.ByteString,? extends R>	ofByteString() Returns the mapping rules of ByteString columns.
protected abstract ColumnTypeMapping<java.lang.Double,? extends R>	ofDouble() Returns the mapping rules of Double columns.
protected abstract ColumnTypeMapping<java.lang.Enum<?>,? extends R>	ofEnum() Returns the mapping rules of Enum columns.
protected abstract ColumnTypeMapping<java.lang.Float,? extends R>	ofFloat() Returns the mapping rules of Float columns.
protected abstract ColumnTypeMapping<java.lang.Integer,? extends R>	ofInteger() Returns the mapping rules of Integer columns.
protected abstract ColumnTypeMapping<java.lang.Long,? extends R>	ofLong() Returns the mapping rules of Long columns.
protected abstract ColumnTypeMapping<com.google.protobuf.Message,? extends R>	ofMessage() Returns the mapping rules of Message columns.
protected abstract ColumnTypeMapping<java.lang.String,? extends R>	ofString() Returns the mapping rules of String columns.
protected void	setupCustomMapping(com.google.common.collect.ImmutableMap.Builder<java.lang.Class<?>,ColumnTypeMapping<?,? extends R>> builder) Allows to specify custom mapping rules.
protected java.lang.IllegalArgumentException	unsupportedType(java.lang.Class<?> aClass) Throws an exception about an unsupported column type.

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.entity.storage.ColumnMapping

ofNull

Constructor Detail

AbstractColumnMapping

public AbstractColumnMapping()

Method Detail

of

public <T> ColumnTypeMapping<T,? extends R> of(java.lang.Class<T> type)

Description copied from interface: ColumnMapping

Obtains the mapping rules for the given type.

Specified by:

of in interface ColumnMapping<R>

Type Parameters:

T - the column type

setupCustomMapping

protected void setupCustomMapping(com.google.common.collect.ImmutableMap.Builder<java.lang.Class<?>,ColumnTypeMapping<?,? extends R>> builder)

Allows to specify custom mapping rules.

If some message types are needed to be stored differently to the generic messages, the rules for their storage can be specified using this method.

The common examples of such messages are Timestamp and Version.

The custom mapping can also be specified for marker interfaces of messages like EventMessage.

ofString

protected abstract ColumnTypeMapping<java.lang.String,? extends R> ofString()

Returns the mapping rules of String columns.

ofInteger

protected abstract ColumnTypeMapping<java.lang.Integer,? extends R> ofInteger()

Returns the mapping rules of Integer columns.

ofLong

protected abstract ColumnTypeMapping<java.lang.Long,? extends R> ofLong()

Returns the mapping rules of Long columns.

ofFloat

protected abstract ColumnTypeMapping<java.lang.Float,? extends R> ofFloat()

Returns the mapping rules of Float columns.

ofDouble

protected abstract ColumnTypeMapping<java.lang.Double,? extends R> ofDouble()

Returns the mapping rules of Double columns.

ofBoolean

protected abstract ColumnTypeMapping<java.lang.Boolean,? extends R> ofBoolean()

Returns the mapping rules of Boolean columns.

ofByteString

protected abstract ColumnTypeMapping<com.google.protobuf.ByteString,? extends R> ofByteString()

Returns the mapping rules of ByteString columns.

ofEnum

protected abstract ColumnTypeMapping<java.lang.Enum<?>,? extends R> ofEnum()

Returns the mapping rules of Enum columns.

ofMessage

protected abstract ColumnTypeMapping<com.google.protobuf.Message,? extends R> ofMessage()

Returns the mapping rules of Message columns.

unsupportedType

protected java.lang.IllegalArgumentException unsupportedType(java.lang.Class<?> aClass)

Throws an exception about an unsupported column type.