apoc.export.cypher.formatter.CypherFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apoc-common Show documentation

Data types package for Neo4j Procedures

There is a newer version: 5.25.1

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package apoc.export.cypher.formatter;

import apoc.export.util.ExportConfig;
import apoc.export.util.Reporter;
import java.io.PrintWriter;
import java.util.Map;
import java.util.Set;
import org.neo4j.graphdb.*;
import org.neo4j.graphdb.schema.ConstraintType;

/**
 * @author AgileLARUS
 *
 * @since 16-06-2017
 */
public interface CypherFormatter {

    String statementForNode(
            Node node,
            Map> uniqueConstraints,
            Set indexedProperties,
            Set indexNames);

    String statementForRelationship(
            Relationship relationship,
            Map> uniqueConstraints,
            Set indexedProperties,
            ExportConfig exportConfig);

    String statementForNodeIndex(
            String indexType, String label, Iterable keys, boolean ifNotExist, String idxName);

    String statementForIndexRelationship(
            String indexType, String type, Iterable keys, boolean ifNotExist, String idxName);

    String statementForNodeFullTextIndex(String name, Iterable labels, Iterable keys);

    String statementForRelationshipFullTextIndex(String name, Iterable types, Iterable keys);

    String statementForCreateConstraint(
            String name, String label, Iterable keys, ConstraintType type, boolean ifNotExist);

    String statementForDropConstraint(String name);

    String statementForCleanUpNodes(int batchSize);

    String statementForCleanUpRelationships(int batchSize);

    void statementForNodes(
            Iterable node,
            Map> uniqueConstraints,
            ExportConfig exportConfig,
            PrintWriter out,
            Reporter reporter,
            GraphDatabaseService db);

    void statementForRelationships(
            Iterable relationship,
            Map> uniqueConstraints,
            ExportConfig exportConfig,
            PrintWriter out,
            Reporter reporter,
            GraphDatabaseService db);
}