org.neo4j.gds.memest.MemoryEstimationGraphConfigParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of memory-estimation Show documentation

Neo4j Graph Data Science :: Memory Estimation

There is a newer version: 2.9.0

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.gds.memest;

import org.neo4j.gds.config.GraphProjectConfig;
import org.neo4j.gds.core.CypherMapWrapper;
import org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig;
import org.neo4j.gds.projection.GraphProjectFromStoreConfig;

import java.util.Map;

import static org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig.NODE_QUERY_KEY;
import static org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig.RELATIONSHIP_QUERY_KEY;
import static org.neo4j.gds.projection.GraphProjectFromStoreConfig.NODE_PROJECTION_KEY;
import static org.neo4j.gds.projection.GraphProjectFromStoreConfig.RELATIONSHIP_PROJECTION_KEY;

public class MemoryEstimationGraphConfigParser {

    private final String username;

    public MemoryEstimationGraphConfigParser(String username) {
        this.username = username;
    }

    public GraphProjectConfig parse(Map graphConfig) {
        var createConfigMapWrapper = CypherMapWrapper.create(graphConfig);
        var result = createConfigMapWrapper.verifyMutuallyExclusivePairs(
            NODE_PROJECTION_KEY,
            RELATIONSHIP_PROJECTION_KEY,
            NODE_QUERY_KEY,
            RELATIONSHIP_QUERY_KEY,
            "Missing information for implicit graph creation."
        );
        if (result == CypherMapWrapper.PairResult.FIRST_PAIR) {
            return GraphProjectFromStoreConfig.fromProcedureConfig(username, createConfigMapWrapper);
        } else {
            return GraphProjectFromCypherConfig.fromProcedureConfig(username, createConfigMapWrapper);
        }
    }
}