All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

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.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

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

/**
 * This adapter will transform an embedded response into a json response
 *
 * @author Vince Bickers
 * @author Michael J. Simons
 */
public class GraphRowModelAdapter implements ResultAdapter, GraphRowModel> {

    private final GraphModelAdapter graphModelAdapter;
    private List columns = new ArrayList<>();

    public GraphRowModelAdapter(GraphModelAdapter graphModelAdapter) {
        this.graphModelAdapter = graphModelAdapter;
    }

    /**
     * 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 GraphRowModel adapt(Map data) {

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

        Set nodeIdentities = new HashSet<>();
        Set edgeIdentities = new HashSet<>();

        DefaultGraphModel graphModel = new DefaultGraphModel();
        List variables = new ArrayList<>();
        List values = new ArrayList<>();

        // 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();

        adapt(iterator, data, graphModel, variables, values, nodeIdentities, edgeIdentities);

        DefaultRowModel rowModel = new DefaultRowModel(values.toArray(new Object[] {}),
            variables.toArray(new String[] {}));

        return new DefaultGraphRowModel(graphModel, rowModel.getValues());
    }

    private void adapt(Iterator iterator, Map data, DefaultGraphModel graphModel,
        List variables, List values, Set nodeIdentities, Set edgeIdentities) {

        while (iterator.hasNext()) {

            String key = iterator.next();
            variables.add(key);

            Object value = data.get(key);
            boolean generatedNodes = ResultAdapter.describesGeneratedNode(key);

            boolean isPath = value != null && graphModelAdapter.isPath(value);
            Iterable elements = isPath ? Collections.singletonList(value) : CollectionUtils.iterableOf(value);
            for (Object element : elements) {
                adapt(element, graphModel, values, nodeIdentities, edgeIdentities, generatedNodes);
            }
        }
    }

    private void adapt(Object element, DefaultGraphModel graphModel, List values, Set nodeIdentities,
        Set edgeIdentities, boolean generatedNodes) {
        if (graphModelAdapter.isPath(element)) {
            graphModelAdapter.buildPath(element, graphModel, nodeIdentities, edgeIdentities, generatedNodes);
        } else if (graphModelAdapter.isNode(element)) {
            graphModelAdapter.buildNode(element, graphModel, nodeIdentities, generatedNodes);
        } else if (graphModelAdapter.isRelationship(element)) {
            graphModelAdapter.buildRelationship(element, graphModel, edgeIdentities);
        } else if (Collection.class.isAssignableFrom(element.getClass())) {
            Collection collection = (Collection) element;
            for (Object value : collection) {
                adapt(value, graphModel, values, nodeIdentities, edgeIdentities, generatedNodes);
            }
        } else {
            values.add(element);
        }
    }

    public void setColumns(List columns) {
        this.columns = columns;
    }
}