org.neo4j.gds.compat.UserFunctionSignature Maven / Gradle / Ivy

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

Neo4j Graph Data Science :: Neo4j Kernel Adapter API

There is a newer version: 2.9.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.compat;

import org.jetbrains.annotations.NotNull;
import org.neo4j.gds.annotation.GenerateBuilder;
import org.neo4j.internal.kernel.api.procs.FieldSignature;
import org.neo4j.internal.kernel.api.procs.Neo4jTypes;
import org.neo4j.internal.kernel.api.procs.QualifiedName;
import org.neo4j.kernel.api.CypherScope;

import java.util.List;
import java.util.Optional;

import static java.util.function.Predicate.not;

@GenerateBuilder
public record UserFunctionSignature(
    @NotNull QualifiedName name,
    @NotNull List inputField,
    @NotNull Neo4jTypes.AnyType returnType,
    @NotNull String description,
    Optional deprecatedBy,
    boolean internal,
    boolean threadSafe
) {
    public org.neo4j.internal.kernel.api.procs.UserFunctionSignature toNeo() {
        String category = null;      // No predefined category (like temporal or math)
        var caseInsensitive = false; // case sensitive name match
        var isBuiltIn = false;       // is built in; never true for GDS
        var deprecated = deprecatedBy.filter(not(String::isEmpty));

        return new org.neo4j.internal.kernel.api.procs.UserFunctionSignature(
            this.name,
            this.inputField,
            this.returnType,
            deprecated.isPresent(),
            deprecated.orElse(null),
            this.description,
            category,
            caseInsensitive,
            isBuiltIn,
            this.internal,
            this.threadSafe,
            CypherScope.ALL_SCOPES
        );
    }
}