org.springframework.cloud.gcp.data.spanner.core.convert

Class ConverterAwareMappingSpannerEntityProcessor

java.lang.Object

org.springframework.cloud.gcp.data.spanner.core.convert.ConverterAwareMappingSpannerEntityProcessor

All Implemented Interfaces:

SpannerEntityProcessor, SpannerEntityWriter, org.springframework.data.convert.EntityWriter<Object,com.google.cloud.spanner.Mutation.WriteBuilder>

public class ConverterAwareMappingSpannerEntityProcessor
extends Object
implements SpannerEntityProcessor

The primary class for writing entity objects to Spanner and creating entity objects from rows stored in Spanner.

Author:

Chengyuan Zhao, Balint Pato

Constructor Summary

Constructors

Constructor and Description
ConverterAwareMappingSpannerEntityProcessor(SpannerMappingContext spannerMappingContext)
ConverterAwareMappingSpannerEntityProcessor(SpannerMappingContext spannerMappingContext, Collection<org.springframework.core.convert.converter.Converter> writeConverters, Collection<org.springframework.core.convert.converter.Converter> readConverters)

Method Summary

Modifier and Type	Method and Description
Class	getCorrespondingSpannerJavaType(Class originalType, boolean isIterableInnerType) Gets the type that will work for both read and writes with Spanner directly.
<T> List<T>	mapToList(com.google.cloud.spanner.ResultSet resultSet, Class<T> entityClass) Converts a set of Spanner ResultSet into a list of objects.
<T> List<T>	mapToList(com.google.cloud.spanner.ResultSet resultSet, Class<T> entityClass, Optional<Set<String>> includeColumns, boolean allowMissingColumns) Converts a set of Spanner ResultSet into a list of objects.
<T> List<T>	mapToList(com.google.cloud.spanner.ResultSet resultSet, Class<T> entityClass, String... includeColumns) Converts a set of Spanner ResultSet into a list of objects.
default <R> R	read(Class<R> type, com.google.cloud.spanner.Struct source)
<R> R	read(Class<R> type, com.google.cloud.spanner.Struct source, Set<String> includeColumns, boolean allowMissingColumns)
void	write(Object source, com.google.cloud.spanner.Mutation.WriteBuilder sink) Writes each of the source properties to the sink.
void	write(Object source, com.google.cloud.spanner.Mutation.WriteBuilder sink, Set<String> includeColumns) Writes an object's properties to the sink.
com.google.cloud.spanner.Key	writeToKey(Object key)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConverterAwareMappingSpannerEntityProcessor

public ConverterAwareMappingSpannerEntityProcessor(SpannerMappingContext spannerMappingContext)

ConverterAwareMappingSpannerEntityProcessor

public ConverterAwareMappingSpannerEntityProcessor(SpannerMappingContext spannerMappingContext,
                                                   Collection<org.springframework.core.convert.converter.Converter> writeConverters,
                                                   Collection<org.springframework.core.convert.converter.Converter> readConverters)

Method Detail

mapToList

public <T> List<T> mapToList(com.google.cloud.spanner.ResultSet resultSet,
                             Class<T> entityClass)

Description copied from interface: SpannerEntityProcessor

Converts a set of Spanner ResultSet into a list of objects.

Specified by:

mapToList in interface SpannerEntityProcessor

Type Parameters:

T - The type of the objects the Spanner results represent.

Parameters:

resultSet - The Spanner results to convert. The ResultSet will be exhausted and closed.

entityClass - The type of the objects the Spanner results represent.

Returns:

A list of objects.

mapToList

public <T> List<T> mapToList(com.google.cloud.spanner.ResultSet resultSet,
                             Class<T> entityClass,
                             Optional<Set<String>> includeColumns,
                             boolean allowMissingColumns)

Description copied from interface: SpannerEntityProcessor

Converts a set of Spanner ResultSet into a list of objects.

Specified by:

mapToList in interface SpannerEntityProcessor

Type Parameters:

T - The type of the objects the Spanner results represent.

Parameters:

resultSet - The Spanner results to convert. The ResultSet will be exhausted and closed.

entityClass - The type of the objects the Spanner results represent.

includeColumns - the Set of columns to read. If the Set is not present or this param is null then all columns will be read.

allowMissingColumns - if true, then properties with no corresponding column are not mapped. If false, then an exception is thrown.

Returns:

A list of objects.

mapToList

public <T> List<T> mapToList(com.google.cloud.spanner.ResultSet resultSet,
                             Class<T> entityClass,
                             String... includeColumns)

Description copied from interface: SpannerEntityProcessor

Converts a set of Spanner ResultSet into a list of objects.

Specified by:

mapToList in interface SpannerEntityProcessor

Type Parameters:

T - The type of the objects the Spanner results represent.

Parameters:

resultSet - The Spanner results to convert. The ResultSet will be exhausted and closed.

entityClass - The type of the objects the Spanner results represent.

includeColumns - the columns to read. If none are provided then all columns are read.

Returns:

A list of objects.

getCorrespondingSpannerJavaType

public Class getCorrespondingSpannerJavaType(Class originalType,
                                             boolean isIterableInnerType)

Description copied from interface: SpannerEntityProcessor

Gets the type that will work for both read and writes with Spanner directly.

Specified by:

getCorrespondingSpannerJavaType in interface SpannerEntityProcessor

Parameters:

originalType - the original type that is possibly convertable by this converter.

isIterableInnerType - true if the given type refers to an inner type. This is significant because Spanner does not support the same types as singular items and as array elements.

Returns:

the Java type that works directly with Spanner.

write

public void write(Object source,
                  com.google.cloud.spanner.Mutation.WriteBuilder sink)

Writes each of the source properties to the sink.

Specified by:

write in interface org.springframework.data.convert.EntityWriter<Object,com.google.cloud.spanner.Mutation.WriteBuilder>

Parameters:

source - entity to be written

sink - the stateful Mutation.WriteBuilder as a target for writing.

write

public void write(Object source,
                  com.google.cloud.spanner.Mutation.WriteBuilder sink,
                  Set<String> includeColumns)

Description copied from interface: SpannerEntityWriter

Writes an object's properties to the sink.

Specified by:

write in interface SpannerEntityWriter

Parameters:

source - the object to write

sink - the sink to which to write

includeColumns - the properties/columns to write. If null, then all columns are written.

writeToKey

public com.google.cloud.spanner.Key writeToKey(Object key)

Specified by:

writeToKey in interface SpannerEntityWriter

read

public <R> R read(Class<R> type,
                  com.google.cloud.spanner.Struct source,
                  Set<String> includeColumns,
                  boolean allowMissingColumns)

read

public <R> R read(Class<R> type,
                  com.google.cloud.spanner.Struct source)

Specified by:

read in interface org.springframework.data.convert.EntityReader<Object,com.google.cloud.spanner.Struct>