org.neo4j.gds.procedures.pipelines.NodeClassificationPredictPipelineMutateConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pipelines-procedure-facade Show documentation

Neo4j Graph Data Science :: Pipelines Procedure Facade

There is a newer version: 2.15.0

Show 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.procedures.pipelines;

import org.neo4j.gds.NodeLabel;
import org.neo4j.gds.RelationshipType;
import org.neo4j.gds.annotation.Configuration;
import org.neo4j.gds.api.GraphStore;
import org.neo4j.gds.config.MutateNodePropertyConfig;
import org.neo4j.gds.core.CypherMapWrapper;

import java.util.Collection;

import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;

@Configuration
public interface NodeClassificationPredictPipelineMutateConfig extends
    NodeClassificationPredictPipelineMutateOrWriteConfig,
    MutateNodePropertyConfig {
    static NodeClassificationPredictPipelineMutateConfig of(String username, CypherMapWrapper config) {
        return new NodeClassificationPredictPipelineMutateConfigImpl(username, config);
    }

    @Configuration.Check
    default void validateMutatePropertiesDiffer() {
        predictedProbabilityProperty().ifPresent(predictedProbabilityProperty -> {
            if (mutateProperty().equals(predictedProbabilityProperty)) {
                throw new IllegalArgumentException(
                    formatWithLocale(
                        "Configuration parameters `%s` and `%s` must be different (both were `%s`)",
                        "mutateProperty",
                        "predictedProbabilityProperty",
                        predictedProbabilityProperty
                    )
                );
            }
        });
    }

    @Configuration.GraphStoreValidationCheck
    default void validatePredictedProbabilityPropertyDoesNotExist(
        GraphStore graphStore,
        Collection selectedLabels,
        Collection selectedRelationshipTypes
    ) {
        predictedProbabilityProperty().ifPresent(predictedProbabilityProperty -> {
            if (graphStore.hasNodeProperty(selectedLabels, predictedProbabilityProperty)) {
                throw new IllegalArgumentException(formatWithLocale(
                    "Node property `%s` already exists in the in-memory graph.",
                    predictedProbabilityProperty
                ));
            }
        });
    }
}