org.neo4j.kernel.api.procedure.GlobalProcedures Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.
There is a newer version: 5.25.1
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.kernel.api.procedure;

import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Stream;

import org.neo4j.collection.RawIterator;
import org.neo4j.exceptions.KernelException;
import org.neo4j.function.ThrowingFunction;
import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
import org.neo4j.internal.kernel.api.procs.Neo4jTypes;
import org.neo4j.internal.kernel.api.procs.ProcedureHandle;
import org.neo4j.internal.kernel.api.procs.ProcedureSignature;
import org.neo4j.internal.kernel.api.procs.QualifiedName;
import org.neo4j.internal.kernel.api.procs.UserAggregator;
import org.neo4j.internal.kernel.api.procs.UserFunctionHandle;
import org.neo4j.internal.kernel.api.procs.UserFunctionSignature;
import org.neo4j.kernel.api.ResourceTracker;
import org.neo4j.values.AnyValue;

public interface GlobalProcedures
{
    void register( CallableProcedure proc ) throws ProcedureException;

    void register( CallableUserFunction function ) throws ProcedureException;

    void register( CallableUserAggregationFunction function ) throws ProcedureException;

    void register( CallableUserFunction function, boolean overrideCurrentImplementation ) throws ProcedureException;

    void registerBuiltIn( CallableUserFunction function ) throws ProcedureException;

    void register( CallableUserAggregationFunction function, boolean overrideCurrentImplementation ) throws ProcedureException;

    void register( CallableProcedure proc, boolean overrideCurrentImplementation ) throws ProcedureException;

    void registerProcedure( Class proc ) throws KernelException;

    void registerProcedure( Class proc, boolean overrideCurrentImplementation ) throws KernelException;

    void registerProcedure( Class proc, boolean overrideCurrentImplementation, String warning ) throws KernelException;

    void registerBuiltInFunctions( Class func ) throws KernelException;

    void registerFunction( Class func ) throws KernelException;

    void registerAggregationFunction( Class func, boolean overrideCurrentImplementation ) throws KernelException;

    void registerAggregationFunction( Class func ) throws KernelException;

    void registerFunction( Class func, boolean overrideCurrentImplementation ) throws KernelException;

    void registerType( Class javaClass, Neo4jTypes.AnyType type );

     void registerComponent( Class cls, ThrowingFunction provider, boolean safe );

    ProcedureHandle procedure( QualifiedName name ) throws ProcedureException;

    UserFunctionHandle function( QualifiedName name );

    UserFunctionHandle aggregationFunction( QualifiedName name );

    int[] getIdsOfFunctionsMatching( Predicate predicate );

    int[] getIdsOfAggregatingFunctionsMatching( Predicate predicate );

    Set getAllProcedures();

    int[] getIdsOfProceduresMatching( Predicate predicate );

    Stream getAllNonAggregatingFunctions();

    Stream getAllAggregatingFunctions();

    RawIterator callProcedure( Context ctx, int id, AnyValue[] input,
            ResourceTracker resourceTracker ) throws ProcedureException;

    AnyValue callFunction( Context ctx, int id, AnyValue[] input ) throws ProcedureException;

    UserAggregator createAggregationFunction( Context ctx, int id ) throws ProcedureException;

     ThrowingFunction lookupComponentProvider( Class cls, boolean safe );

}