org.springframework.data.r2dbc.convert.ColumnMapRowMapper Maven / Gradle / Ivy
Show all versions of spring-data-r2dbc-dsl Show documentation
/*
* Copyright 2018-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.r2dbc.convert;
import io.r2dbc.spi.ColumnMetadata;
import io.r2dbc.spi.Row;
import io.r2dbc.spi.RowMetadata;
import java.util.Map;
import java.util.function.BiFunction;
import org.springframework.lang.Nullable;
import org.springframework.util.LinkedCaseInsensitiveMap;
/**
* {@link BiFunction Mapping function} implementation that creates a {@link Map} for each row, representing all columns
* as key-value pairs: one entry for each column, with the column name as key.
*
* The {@link Map} implementation to use and the key to use for each column in the column Map can be customized through
* overriding {@link #createColumnMap} and {@link #getColumnKey}, respectively.
*
* Note: By default, {@link ColumnMapRowMapper} will try to build a linked {@link Map} with case-insensitive
* keys, to preserve column order as well as allow any casing to be used for column names. This requires Commons
* Collections on the classpath (which will be autodetected). Else, the fallback is a standard linked
* {@link java.util.HashMap}, which will still preserve column order but requires the application to specify the column
* names in the same casing as exposed by the driver.
*
* @author Mark Paluch
* @deprecated since 1.2, use Spring R2DBC's {@link org.springframework.r2dbc.core.ColumnMapRowMapper} directly.
*/
public class ColumnMapRowMapper extends org.springframework.r2dbc.core.ColumnMapRowMapper {
public final static ColumnMapRowMapper INSTANCE = new ColumnMapRowMapper();
@Override
public Map apply(Row row, RowMetadata rowMetadata) {
return super.apply(row, rowMetadata);
}
/**
* Create a {@link Map} instance to be used as column map.
*
* By default, a linked case-insensitive Map will be created.
*
* @param columnCount the column count, to be used as initial capacity for the Map.
* @return the new {@link Map} instance.
* @see LinkedCaseInsensitiveMap
*/
protected Map createColumnMap(int columnCount) {
return super.createColumnMap(columnCount);
}
/**
* Determine the key to use for the given column in the column {@link Map}.
*
* @param columnName the column name as returned by the {@link Row}.
* @return the column key to use.
* @see ColumnMetadata#getName()
*/
protected String getColumnKey(String columnName) {
return super.getColumnKey(columnName);
}
/**
* Retrieve a R2DBC object value for the specified column.
*
* The default implementation uses the {@link Row#get(int)} method.
*
* @param row is the {@link Row} holding the data.
* @param index is the column index.
* @return the Object returned.
*/
@Nullable
protected Object getColumnValue(Row row, int index) {
return super.getColumnValue(row, index);
}
}