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

Interface SpannerEntityProcessor

All Superinterfaces:

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

All Known Implementing Classes:

ConverterAwareMappingSpannerEntityProcessor

public interface SpannerEntityProcessor
extends SpannerEntityWriter

Interface for processors that can populate fields from Spanner Structs and write them to Spanner Mutations.

Author:

Ray Tsang, Chengyuan Zhao, Balint Pato

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)

Methods inherited from interface org.springframework.cloud.gcp.data.spanner.core.convert.SpannerEntityWriter

write, writeToKey

Methods inherited from interface org.springframework.data.convert.EntityWriter

write

Method Detail

mapToList

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

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

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

<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.

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

<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.

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

Class getCorrespondingSpannerJavaType(Class originalType,
                                      boolean isIterableInnerType)

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

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.

read

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

read

default <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>