org.neo4j.ogm.result.adapter.RowModelAdapter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-ogm-api Show documentation

Neo4j-OGM's internal Api for connecting different transports.

The newest version!

/*
 * Copyright (c) 2002-2024 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * 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
 *
 *     http://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.neo4j.ogm.result.adapter;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.neo4j.ogm.exception.ResultProcessingException;
import org.neo4j.ogm.model.RowModel;
import org.neo4j.ogm.response.model.DefaultRowModel;
import org.neo4j.ogm.support.CollectionUtils;

/**
 * This adapter will transform a Map<String,Object> typically representing an Embedded or Bolt response into a {@link RowModel} response
 *
 * @author vince
 * @author Luanne Misquitta
 */
public abstract class RowModelAdapter implements ResultAdapter, RowModel> {

    private List columns = new ArrayList<>();

    /**
     * Reads the next row from the result object and transforms it into a RowModel object
     *
     * @param data the data to transform, given as a map
     * @return the data transformed to an {@link RowModel}
     */
    public RowModel adapt(Map data) {

        if (columns == null) {
            throw new ResultProcessingException("Result columns should not be null");
        }

        // there is no guarantee that the objects in the data are ordered the same way as required by the columns
        // so we use the columns information to extract them in the correct order for post-processing.
        Iterator iterator = columns.iterator();

        List variables = new ArrayList<>();
        List