org.neo4j.gds.algorithms.similarity.Neo4jDatabaseRelationshipWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algo Show documentation
Neo4j Graph Data Science :: Algorithms
The newest version!
/*
 * 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.algorithms.similarity;

import org.neo4j.gds.api.Graph;
import org.neo4j.gds.api.IdMap;
import org.neo4j.gds.api.ResultStore;
import org.neo4j.gds.api.properties.relationships.RelationshipWithPropertyConsumer;
import org.neo4j.gds.core.utils.ProgressTimer;
import org.neo4j.gds.core.utils.progress.JobId;
import org.neo4j.gds.core.utils.progress.TaskRegistryFactory;
import org.neo4j.gds.core.utils.progress.tasks.TaskProgressTracker;
import org.neo4j.gds.core.write.RelationshipExporter;
import org.neo4j.gds.core.write.RelationshipExporterBuilder;
import org.neo4j.gds.logging.Log;
import org.neo4j.gds.termination.TerminationFlag;

import java.util.Optional;
import java.util.concurrent.atomic.AtomicLong;

final class Neo4jDatabaseRelationshipWriter {
    static WriteRelationshipResult writeRelationship(
        String writeRelationshipType,
        String writeProperty,
        TaskRegistryFactory taskRegistryFactory,
        RelationshipExporterBuilder relationshipExporterBuilder,
        Graph graph,
        IdMap rootIdMap,
        Log log,
        String taskName,
        TerminationFlag algorithmTerminationFlag,
        Optional resultStore,
        RelationshipWithPropertyConsumer relationshipConsumer,
        JobId jobId
    ){
        var writeMillis = new AtomicLong();
        try (ProgressTimer ignored = ProgressTimer.start(writeMillis::set)) {
            var progressTracker = new TaskProgressTracker(
                RelationshipExporter.baseTask(taskName, graph.relationshipCount()),
                log,
                RelationshipExporterBuilder.TYPED_DEFAULT_WRITE_CONCURRENCY,
                taskRegistryFactory
            );

            var exporter = relationshipExporterBuilder
                .withIdMappingOperator(rootIdMap::toOriginalNodeId)
                .withGraph(graph)
                .withTerminationFlag(algorithmTerminationFlag)
                .withProgressTracker(progressTracker)
                .withResultStore(resultStore)
                .withJobId(jobId)
                .build();

            exporter.write(
                writeRelationshipType,
                writeProperty,
               relationshipConsumer
            );

        }
        return new WriteRelationshipResult(graph.relationshipCount(), writeMillis.get());
    }

    private Neo4jDatabaseRelationshipWriter() {}
}